How to Contribute to This Portal#

Clone the repository, build locally, and submit your changes.

This guide covers how to contribute to the SKA Developer Portal. For documentation standards and style guidance, see the Documentation Style Guide.

Quick Edit via GitLab#

For small changes, use the Edit on GitLab button on any page.

After logging in:

If you don’t have write access, GitLab automatically creates a fork for you.

For larger changes, set up local development to preview your work.

Use SSH (recommended):

git clone --recurse-submodules git@gitlab.com:ska-telescope/developer.skatelescope.org.git

Or HTTPS:

git clone --recurse-submodules https://gitlab.com/ska-telescope/developer.skatelescope.org.git

If you already have a clone, update submodules:

git submodule update --init --recursive

Install Poetry if you don’t have it
Create a virtual environment and install dependencies:
```
poetry shell
poetry install
```

Inside the virtual environment:

make docs-build html

This creates ./build/html. Open ./build/html/index.html in a browser to preview.

git checkout -b your-branch-name

Make your changes, then commit:

git add .
git commit -m "Brief description of changes"
git push origin your-branch-name

Use the View app button on your merge request to share a preview without requiring others to build locally.

For wider consultation, ask the team in `System Team Support Service Desk<https://jira.skatelescope.org/servicedesk/customer/portal/166/create/298>`__ or leave a comment on the Merge Request to have your version added to the ReadTheDocs version dropdown.

After approval: