Skip to content

Add Docs for Github Codespaces #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

mahmoudmagdy1-1
Copy link

@mahmoudmagdy1-1 mahmoudmagdy1-1 commented Aug 12, 2025

User description

This is the documentation PR for joomla/joomla-cms#45719


PR Type

Documentation


Description

  • Add comprehensive GitHub Codespaces documentation for testing

  • Include step-by-step setup and usage guide

  • Update main testing index with Codespaces option

  • Provide screenshots and detailed environment instructions


Diagram Walkthrough

flowchart LR
  A["New Codespaces Guide"] --> B["Setup Instructions"]
  A --> C["Environment Details"]
  A --> D["Testing Workflow"]
  E["Updated Index"] --> F["Codespaces Option"]
  E --> G["Local Environment"]
Loading

File Walkthrough

Relevant files
Documentation
github-codespaces.md
New GitHub Codespaces testing documentation                           

docs/testing/manually/github-codespaces.md

  • Create comprehensive GitHub Codespaces documentation
  • Include setup steps, environment details, and testing workflow
  • Add sections for phpMyAdmin, Cypress testing, and PR checkout
  • Reference screenshots for visual guidance
+71/-0   
index.md
Update testing index with Codespaces option                           

docs/testing/manually/index.md

  • Add GitHub Codespaces as testing environment option
  • Explain benefits of cloud-based testing setup
  • Link to new Codespaces documentation
  • Reorganize content with local vs cloud options
+17/-0   

Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Clarity

In "The Codespace Environment", the sentence about codespace-details.txt is missing a preposition ("credentials access"); consider rephrasing to improve readability.

Once the setup is complete, you will be in a Visual Studio Code environment within your browser. A file named `codespace-details.txt` will be available, 
containing all the necessary credentials access the Joomla installation.
Accuracy

Verify that the "Code" button and "Create codespace" option accurately reflect current GitHub UI for PR pages; wording might need to specify "Code" dropdown on the repository/PR and "Create codespace on main/branch".

1.  Navigate to the pull request you want to test on GitHub.
2.  Click the **Code** button in the top right.
3.  Select the **Create codespace** option.
![create github codespace](_assets/create-github-codespace.png)
4.  A new browser tab will open, and GitHub will begin creating the Codespace. This process will take a few minutes as it sets up the entire Joomla 
Completeness

Consider adding notes on resource limits/timeouts of Codespaces, cost implications, and persistence (e.g., how to resume a stopped codespace) to set tester expectations.

## The Codespace Environment

Once the setup is complete, you will be in a Visual Studio Code environment within your browser. A file named `codespace-details.txt` will be available, 
containing all the necessary credentials access the Joomla installation.

![vscode initial setup](_assets/initial-vscode-setup.png)

Copy link
Contributor

qodo-merge-pro bot commented Aug 12, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
High-level
Verify image asset paths

The new docs reference multiple screenshots under _assets/, but the PR doesn’t
include those assets nor confirm their path relative to the docs build system.
Ensure all images are added to the repo and that paths comply with the docs
site’s static asset conventions, otherwise the guide will ship with broken
images.

Examples:

docs/testing/manually/github-codespaces.md [17]
![create github codespace](_assets/create-github-codespace.png)
docs/testing/manually/github-codespaces.md [26]
![vscode initial setup](_assets/initial-vscode-setup.png)

Solution Walkthrough:

Before:

# In docs/testing/manually/github-codespaces.md
...
3.  Select the **Create codespace** option.
![create github codespace](_assets/create-github-codespace.png)
...

# PR does not include the image file:
# _assets/create-github-codespace.png

After:

# In docs/testing/manually/github-codespaces.md
...
3.  Select the **Create codespace** option.
![create github codespace](_assets/create-github-codespace.png)
...

# PR should also add the image files, for example:
# + /docs/testing/manually/_assets/create-github-codespace.png
# + /docs/testing/manually/_assets/initial-vscode-setup.png
# ... and all other images
Suggestion importance[1-10]: 9

__

Why: This suggestion correctly identifies a critical issue where referenced images are missing from the PR, which would result in broken content in the new documentation page.

High
General
Use stable absolute link
Suggestion Impact:The commit updated the relative link ./github-codespaces.md to the absolute path /testing/manually/github-codespaces as suggested.

code diff:

-For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](./github-codespaces.md)** documentation.
+For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](/testing/manually/github-codespaces)** documentation.

Use an absolute docs link to ensure the reference resolves correctly in all
build contexts and avoid broken links if this file moves. This prevents
navigation errors.

docs/testing/manually/index.md [25]

-For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](./github-codespaces.md)** documentation.
+For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](/testing/manually/github-codespaces)** documentation.

[Suggestion processed]

Suggestion importance[1-10]: 7

__

Why: The suggestion correctly proposes changing a relative link to an absolute one, which is a best practice for documentation maintainability and helps prevent broken links if files are moved.

Medium
Clarify port naming and URL
Suggestion Impact:The commit updated the documentation text to generalize port names and specify clicking the HTTP(S) forwarded URL, matching the suggested clarification.

code diff:

-To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports for the Web Server and Cypress GUI. Click the 
-globe icon next to the "Web Server" to open the Joomla site in a new tab.
+To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports (e.g., "Web Server", "Cypress"). Click the globe icon next to the HTTP(S) forwarded URL for the web server to open the Joomla site in a new tab.

Clarify that ports may be labeled differently and ensure the user opens the
correct forwarded URL (HTTPS) to avoid mixed-content or blocked popups. This
reduces user confusion when port names differ.

docs/testing/manually/github-codespaces.md [35-36]

-To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports for the Web Server and Cypress GUI. Click the 
-globe icon next to the "Web Server" to open the Joomla site in a new tab.
+To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports (e.g., "Web Server", "Cypress"). Click the globe icon next to the HTTP(S) forwarded URL for the web server to open the Joomla site in a new tab.

[Suggestion processed]

Suggestion importance[1-10]: 6

__

Why: The suggestion improves the documentation by making the instructions for accessing forwarded ports more generic and robust, which helps prevent user confusion if port labels change in the future.

Low
Fix grammatical clarity
Suggestion Impact:The commit added "to" in the sentence, changing "credentials access" to "credentials to access," exactly as suggested.

code diff:

 Once the setup is complete, you will be in a Visual Studio Code environment within your browser. A file named `codespace-details.txt` will be available, 
-containing all the necessary credentials access the Joomla installation.
+containing all the necessary credentials to access the Joomla installation.

Fix the grammatical error to clarify that the credentials are used to access the
Joomla installation. This improves readability and prevents confusion for users
following the steps.

docs/testing/manually/github-codespaces.md [24]

-containing all the necessary credentials access the Joomla installation.
+containing all the necessary credentials to access the Joomla installation.

[Suggestion processed]

Suggestion importance[1-10]: 3

__

Why: The suggestion corrects a minor grammatical error by adding the word to, which slightly improves the readability of the documentation.

Low
  • Update

@mahmoudmagdy1-1
Copy link
Author

Verify image asset paths

images paths are correct and images show correctly, I'm not sure what is wrong

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant