From a77ee98e6f3423b0fb352c119310675ace38906b Mon Sep 17 00:00:00 2001 From: Fabricio Aguiar Date: Tue, 11 Feb 2025 10:56:50 +0000 Subject: [PATCH] Fix docs broken links - remove reference to the vagrant env - fix the link for the docker compose - update CI badges No-Issue Signed-off-by: Fabricio Aguiar --- README.md | 2 +- docs/dev/docker_environment.md | 1 + docs/dev/getting_started.md | 4 ++-- docs/index.md | 6 +++--- mkdocs.yml | 5 ++--- 5 files changed, 9 insertions(+), 9 deletions(-) create mode 120000 docs/dev/docker_environment.md diff --git a/README.md b/README.md index 56ccc55454..4b21d61157 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Galaxy NG -[![Build Status](https://github.com/ansible/galaxy_ng/actions/workflows/ci.yml/badge.svg)](https://github.com/ansible/galaxy_ng/actions/workflows/ci.yml) +[![Build Status](https://github.com/ansible/galaxy_ng/actions/workflows/ci-docker-compose-integration.yml/badge.svg)](https://github.com/ansible/galaxy_ng/actions/workflows/ci-docker-compose-integration.yml) A Pulp plugin to support hosting your very own Ansible Galaxy server. diff --git a/docs/dev/docker_environment.md b/docs/dev/docker_environment.md new file mode 120000 index 0000000000..fb6c43035b --- /dev/null +++ b/docs/dev/docker_environment.md @@ -0,0 +1 @@ +../../dev/compose/README.md \ No newline at end of file diff --git a/docs/dev/getting_started.md b/docs/dev/getting_started.md index 8752655f59..8104d87102 100644 --- a/docs/dev/getting_started.md +++ b/docs/dev/getting_started.md @@ -4,7 +4,7 @@ ### Docker Compose -> **TO BE DEFINED** +[Docker Compose Env developer setup guide](docker_environment.md) ### OCI Env @@ -22,7 +22,7 @@ UI PRs should be submitted at [github.com/ansible/ansible-hub-ui](https://github When submitting a PR to either the UI or backend: -- All PRs must include either `Issue: AAH-XXXX` or `No-Issue` in the commit message. +- All PRs must include either `Issue: AAH-XXXX` or `No-Issue` in the commit message. - `No-Issue` should be used infrequently and the reviewers may ask you to create a Jira ticket and attach it to your PR. - `Issue: AAH-XXXX` should must include a Jira ticket number (such as AAH-123). This also requires a changelog entry in `CHANGES/`. Changelog entries follow the `.type` format. For example if I submit a fix for AAH-123, it must also come with a `CHANGES/123.bugfix` entry. Changelog file extensions include: diff --git a/docs/index.md b/docs/index.md index 6a4fb1b47a..104c0395d5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,9 +5,9 @@ # Galaxy NG -[![Build Status](https://github.com/ansible/galaxy_ng/actions/workflows/ci.yml/badge.svg)](https://github.com/ansible/galaxy_ng/actions/workflows/ci.yml) +[![Build Status](https://github.com/ansible/galaxy_ng/actions/workflows/ci-docker-compose-integration.yml/badge.svg)](https://github.com/ansible/galaxy_ng/actions/workflows/ci-docker-compose-integration.yml) -**Source Code**: [https://github.com/ansible/galaxy_ng](https://github.com/ansible/galaxy_ng) +**Source Code**: [https://github.com/ansible/galaxy_ng](https://github.com/ansible/galaxy_ng) A [Pulp](https://pulpproject.org) plugin to support hosting your very own Ansible Galaxy server. @@ -22,4 +22,4 @@ Check out our: - [Installation guide](usage_guide/installation.md) to install Galaxy NG - [Collection guide](usage_guide/collections.md) for information on managing collections - [Execution environment guide](usage_guide/execution_environments.md) for information on managing execution environments -- [RBAC and User management guide](usage_guide/rbac.md) for information on setting up users and managing permissions \ No newline at end of file +- [RBAC and User management guide](usage_guide/rbac.md) for information on setting up users and managing permissions diff --git a/mkdocs.yml b/mkdocs.yml index d234d4ce82..32b30b0526 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,7 +13,7 @@ nav: - Managing user access: config/user_access.md - Enabling collection signing: config/collection_signing.md - Enabling Container signing: config/container_signing.md - - Feature Flags: config/featureflags.md + - Feature Flags: config/featureflags.md - User Guides: - Installation: usage_guide/installation.md - Collections: usage_guide/collections.md @@ -25,7 +25,7 @@ nav: # - Using Keycloak SSO: integration/keycloak.md # - Using S3: integration/s3.md # - Using Azure: integration/azure.md - + - Contributing: - Getting Started: dev/getting_started.md - GalaxyNG Basics: @@ -36,7 +36,6 @@ nav: - RBAC: dev/developer_guide/rbac.md - Docker compose environment: dev/docker_environment.md - OCI Env Environment: dev/oci_env.md - - Vagrant environment: dev/vagrant.md - Writing documentation: dev/writing_docs.md - Keyword searches: dev/keyword_searching_explanation.md - Integration Tests: dev/integration_tests.md