Skip to content

Update CollectOSS documentation URLs #341

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.

Sign up for GitHub

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

Merged
MoralCode merged 2 commits into from
Jun 2, 2026
Merged

Update CollectOSS documentation URLs #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eb1b831
Update CollectOSS documentation URLs
chrisx9z May 26, 2026
c9f66cd
set stable docs urls back to "release"
MoralCode Jun 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ These resources are a great way to meet the people behind the project, ask quest

## Learn about the project

If you aren't already familiar with what CollectOSS is, please make sure you've read the [README](README.md) to get a primer on our project, and maybe take a look around the [documentation](https://collectoss.readthedocs.io/en/release/) so you know what we are about. You can also hang out in Slack or join our community meetings to learn more about what we do.
If you aren't already familiar with what CollectOSS is, please make sure you've read the [README](README.md) to get a primer on our project, and maybe take a look around the [documentation](https://docs.collectoss.org/en/release/) so you know what we are about. You can also hang out in Slack or join our community meetings to learn more about what we do.

## Opening an issue
If you're experiencing an issue with CollectOSS you can search for your problem or question on our [issues](https://github.com/chaoss/collectoss/issues) page to see if someone else has already reported it. If you cannot find your issue, please feel free to [open a new one](https://github.com/chaoss/collectoss/issues/new/choose).
Expand Down Expand Up @@ -53,7 +53,7 @@ Github has an article called [Syncing a fork](https://docs.github.com/en/pull-re

## Helpful Links

- [CollectOSS stable documentation](https://collectoss.readthedocs.io/en/release/)
- [CollectOSS stable documentation](https://docs.collectoss.org/en/release/)
- [CHAOSS Getting Started page](https://chaoss.community/kb-getting-started/)

**Git & GitHub**
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Basic initial setup can be completed in a few minutes as follows:
3. Copy the `environment.txt` file to a new file called `.env` and fill in values for the required variables
4. Run `docker compose up` to start the containers

Check out the [CollectOSS Documentation](https://collectoss.readthedocs.io) for more detailed setup instructions and troubleshooting steps.
Check out the [CollectOSS Documentation](https://docs.collectoss.org) for more detailed setup instructions and troubleshooting steps.

## Contributing
We strongly believe that communities are what makes open source so impactful. We invite you to join our community, regardless of your experience level or coding abilities!
Expand Down
2 changes: 1 addition & 1 deletion docker/backend/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ FROM python:3.11-slim-bullseye
LABEL org.opencontainers.image.authors="CHAOSS https://chaoss.community"
LABEL org.opencontainers.image.licenses="MIT"
LABEL org.opencontainers.image.source="https://github.com/chaoss/collectoss"
LABEL org.opencontainers.image.documentation="https://collectoss.readthedocs.io"
LABEL org.opencontainers.image.documentation="https://docs.collectoss.org"

ARG VERSION
LABEL org.opencontainers.image.version=${VERSION}
Expand Down
2 changes: 1 addition & 1 deletion docker/database/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
LABEL org.opencontainers.image.authors="CHAOSS https://chaoss.community"
LABEL org.opencontainers.image.licenses="MIT"
LABEL org.opencontainers.image.source="https://github.com/chaoss/collectoss"
LABEL org.opencontainers.image.documentation="https://collectoss.readthedocs.io"
LABEL org.opencontainers.image.documentation="https://docs.collectoss.org"

ARG VERSION
LABEL org.opencontainers.image.version=${VERSION}
Expand All @@ -13,7 +13,7 @@

ENV POSTGRES_DB="test"
ENV POSTGRES_USER="augur"
ENV POSTGRES_PASSWORD="augur"

Check warning on line 16 in docker/database/Dockerfile

View workflow job for this annotation

GitHub Actions / End-to-end test (Docker)

Sensitive data should not be used in the ARG or ENV commands 

SecretsUsedInArgOrEnv: Do not use ARG or ENV instructions for sensitive data (ENV "POSTGRES_PASSWORD")
More info: https://docs.docker.com/go/dockerfile/rule/secrets-used-in-arg-or-env/

EXPOSE 5432

Expand Down
2 changes: 1 addition & 1 deletion docker/keyman/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
LABEL org.opencontainers.image.authors="CHAOSS https://chaoss.community"
LABEL org.opencontainers.image.licenses="MIT"
LABEL org.opencontainers.image.source="https://github.com/chaoss/collectoss"
LABEL org.opencontainers.image.documentation="https://collectoss.readthedocs.io"
LABEL org.opencontainers.image.documentation="https://docs.collectoss.org"

ARG VERSION
LABEL org.opencontainers.image.version=${VERSION}
Expand All @@ -15,7 +15,7 @@
RUN pip install --no-cache-dir redis==4.3.3

ENV KEYMAN_DOCKER=1
ENV PYTHONPATH="${PYTHONPATH}:/collectoss"

Check warning on line 18 in docker/keyman/Dockerfile

View workflow job for this annotation

GitHub Actions / End-to-end test (Docker)

Variables should be defined before their use 

UndefinedVar: Usage of undefined variable '$PYTHONPATH'
More info: https://docs.docker.com/go/dockerfile/rule/undefined-var/
# Ensure Python output is sent straight to terminal (e.g. for Docker logs)
ENV PYTHONUMBUFFERED=1

Expand Down
2 changes: 1 addition & 1 deletion docker/rabbitmq/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
LABEL org.opencontainers.image.authors="CHAOSS https://chaoss.community"
LABEL org.opencontainers.image.licenses="MIT"
LABEL org.opencontainers.image.source="https://github.com/chaoss/collectoss"
LABEL org.opencontainers.image.documentation="https://collectoss.readthedocs.io"
LABEL org.opencontainers.image.documentation="https://docs.collectoss.org"

ARG VERSION
LABEL org.opencontainers.image.version=${VERSION}

ARG RABBIT_MQ_DEFAULT_USER=augur
ARG RABBIT_MQ_DEFAULT_PASSWORD=password123

Check warning on line 12 in docker/rabbitmq/Dockerfile

View workflow job for this annotation

GitHub Actions / End-to-end test (Docker)

Sensitive data should not be used in the ARG or ENV commands 

SecretsUsedInArgOrEnv: Do not use ARG or ENV instructions for sensitive data (ARG "RABBIT_MQ_DEFAULT_PASSWORD")
More info: https://docs.docker.com/go/dockerfile/rule/secrets-used-in-arg-or-env/
ARG RABBIT_MQ_DEFAULT_VHOST=collectoss_vhost

COPY --chown=rabbitmq:rabbitmq ./docker/rabbitmq/collectoss.conf /etc/rabbitmq/conf.d/
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ collectoss = "collectoss.application.cli._multicommand:run"

[project.urls]
Homepage = "https://github.com/chaoss/collectoss"
Documentation = "https://collectoss.readthedocs.io/en/latest/"
Documentation = "https://docs.collectoss.org/en/latest/"


############################################################
Expand Down
4 changes: 2 additions & 2 deletions scripts/docker/config.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function get_github_api_key() {
echo
echo "Please provide a valid GitHub API key."
echo "For more information on how to create the key, visit:"
echo "https://collectoss.readthedocs.io/en/latest/getting-started/installation.html#backend"
echo "https://docs.collectoss.org/en/latest/getting-started/collecting-data.html"
echo "** This is required for CollectOSS to gather data ***"
read -p "GitHub API Key: " github_api_key
blank_confirm github_api_key
Expand All @@ -63,7 +63,7 @@ function get_gitlab_api_key() {
echo
echo "Please provide a valid GitLab API key."
echo "For more information on how to create the key, visit:"
echo "https://collectoss.readthedocs.io/en/latest/getting-started/installation.html#backend"
echo "https://docs.collectoss.org/en/latest/getting-started/collecting-data.html"
echo "** This is required for CollectOSS to gather data ***"
read -p "GitLab API Key: " gitlab_api_key
blank_confirm gitlab_api_key
Expand Down
Loading