Skip to content

Commit

Permalink
Fix docs broken links (#2415)
Browse files Browse the repository at this point in the history
- remove reference to the vagrant env
- fix the link for the docker compose
- update CI badges

No-Issue

Signed-off-by: Fabricio Aguiar <[email protected]>
  • Loading branch information
fao89 authored Feb 13, 2025
1 parent b525b5f commit 851e173
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
1 change: 1 addition & 0 deletions docs/dev/docker_environment.md
4 changes: 2 additions & 2 deletions docs/dev/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

### Docker Compose

> **TO BE DEFINED**
[Docker Compose Env developer setup guide](docker_environment.md)

### OCI Env

Expand All @@ -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 `<issue_number>.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:
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
- [RBAC and User management guide](usage_guide/rbac.md) for information on setting up users and managing permissions
5 changes: 2 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand Down

0 comments on commit 851e173

Please sign in to comment.