From eb1b831f48e67ff1ca0c74ba3190bb3c5fd69030 Mon Sep 17 00:00:00 2001 From: chrisx9z <287960381+chrisx9z@users.noreply.github.com> Date: Tue, 26 May 2026 22:04:46 +0700 Subject: [PATCH] Update CollectOSS documentation URLs This commit replaces the old Read the Docs host with docs.collectoss.org and points CLI help text to live documentation pages. Signed-off-by: chrisx9z <287960381+chrisx9z@users.noreply.github.com> --- CONTRIBUTING.md | 4 ++-- README.md | 2 +- docker/backend/Dockerfile | 2 +- docker/database/Dockerfile | 2 +- docker/keyman/Dockerfile | 2 +- docker/rabbitmq/Dockerfile | 2 +- pyproject.toml | 2 +- scripts/docker/config.sh | 4 ++-- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d9182b26..42011a252 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/latest/) 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). @@ -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/latest/) - [CHAOSS Getting Started page](https://chaoss.community/kb-getting-started/) **Git & GitHub** diff --git a/README.md b/README.md index be144d755..983fdfe66 100644 --- a/README.md +++ b/README.md @@ -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! diff --git a/docker/backend/Dockerfile b/docker/backend/Dockerfile index 98e9f06ef..d3ada5bf0 100644 --- a/docker/backend/Dockerfile +++ b/docker/backend/Dockerfile @@ -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} diff --git a/docker/database/Dockerfile b/docker/database/Dockerfile index aa769649c..c239db9b6 100644 --- a/docker/database/Dockerfile +++ b/docker/database/Dockerfile @@ -4,7 +4,7 @@ FROM postgres:16 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} diff --git a/docker/keyman/Dockerfile b/docker/keyman/Dockerfile index 93de9fc28..33413a680 100644 --- a/docker/keyman/Dockerfile +++ b/docker/keyman/Dockerfile @@ -3,7 +3,7 @@ FROM python:3.11.12-alpine 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} diff --git a/docker/rabbitmq/Dockerfile b/docker/rabbitmq/Dockerfile index 6e8916f32..aea2806ac 100644 --- a/docker/rabbitmq/Dockerfile +++ b/docker/rabbitmq/Dockerfile @@ -3,7 +3,7 @@ FROM rabbitmq:4.1-management-alpine 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} diff --git a/pyproject.toml b/pyproject.toml index d14c871f7..490e14dc7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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/" ############################################################ diff --git a/scripts/docker/config.sh b/scripts/docker/config.sh index 6170ea57e..6f92c9a36 100755 --- a/scripts/docker/config.sh +++ b/scripts/docker/config.sh @@ -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 @@ -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