Skip to content
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.

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

[Docs] fix docs warnings and broken links #1840

Merged
merged 2 commits into from
Aug 17, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
6 changes: 3 additions & 3 deletions docs/config/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can find more information about pulp configuration on [Pulp Docs](https://do


!!! tip
If you are looking for how to set configuration options on the pulp-installer take a look on [installation page](/installation)
If you are looking for how to set configuration options on the pulp-installer take a look on [pulp options](#pulp-django-and-other-plugins)

## Configuring your galaxy server

Expand Down Expand Up @@ -157,7 +157,7 @@ Here is a [diagram explaining](https://www.xmind.net/m/VPSF59/#) the loading ord
| `GALAXY_API_STAGING_DISTRIBUTION_BASE_PATH` | Distribution where collections go when waiting for approval, Default: `"staging"` |
| `GALAXY_API_REJECTED_DISTRIBUTION_BASE_PATH` | Distribution where collections go after rejection, Default: `"rejected"` |
| `GALAXY_REQUIRE_CONTENT_APPROVAL` | Sets if system requires uploaded collections to be manually approved, Default: `True` (if set to false all uploaded collections are automatically approved) |
| `GALAXY_FEATURE_FLAGS` | A dictionary that toggles specific flags [see feature flags page](/config/featureflags) |
| `GALAXY_FEATURE_FLAGS` | A dictionary that toggles specific flags [see feature flags page](featureflags.md) |
| `GALAXY_ENABLE_UNAUTHENTICATED_COLLECTION_ACCESS` | Enabled anonymous browsing, Default: `False` |
| `GALAXY_ENABLE_UNAUTHENTICATED_COLLECTION_DOWNLOAD` | Enabled anonymous download, Default: `False` |
| `GALAXY_ENABLE_API_ACCESS_LOG` | Enable gathering of logs, Default: `False` |
Expand All @@ -173,7 +173,7 @@ Here is a [diagram explaining](https://www.xmind.net/m/VPSF59/#) the loading ord
| `GALAXY_REQUIRE_SIGNATURE_FOR_APPROVAL` | Approval dashboard and move endpoint must require signature?, Default: `False` |
| `GALAXY_MINIMUM_PASSWORD_LENGTH` | Minimum password lenght for validation, Default: 9 |

For SSO Keycloak configuration see [keycloak](keycloak)
For SSO Keycloak configuration see [keycloak](../dev/docker_environment.md#keycloak)

### Pulp, Django and other plugins

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/docker_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ If you want to login as a superuser, you can do one of two things:

Unit and integration tests can be easily run using docker compose. At the moment, there is no easy way to run pulp functional tests with docker.

For more information on tests, refer to [writing tests](dev/writing_tests.md).
For more information on tests, refer to [writing tests](integration_tests.md).

### Unit tests

Expand Down
8 changes: 4 additions & 4 deletions docs/dev/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ This is recommended for beginners. It's less error prone and easier to setup, ho
- are developing using a Mac
- writing documentation

[Docker environment developer setup guide](/galaxy_ng/dev/docker_environment).
[Docker environment developer setup guide](docker_environment.md).

### OCI Env

This is the new preferred way to develop with pulp. It provides a flexible, containerized environment that's easy to set up. It supports running integration and functional tests as well as developing the UI. It supports all the features from the docker and vagrant environments, but isn't as heavily tested as the docker environment.

[OCI Env developer setup guide](/galaxy_ng/dev/oci_env)
[OCI Env developer setup guide](oci_env.md)

### Vagrant Environment

Expand All @@ -30,7 +30,7 @@ This uses the [Pulp developer environment](https://docs.pulpproject.org/pulpcore
- need to run pulpcore and pulp_ansible without the galaxy_ng plugin installed
- need to debug an issue on an operating system other than RHEL/Centos

[Vagrant environment developer setup guide](/galaxy_ng/dev/vagrant)
[Vagrant environment developer setup guide](vagrant.md)

## Issue Tracker

Expand All @@ -47,7 +47,7 @@ When submitting a PR to either the UI or backend:
- `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:

- `.feature`: use this for new features. New features must include documentation. See our [docs documentation](dev/writing_docs.md) for more information.
- `.feature`: use this for new features. New features must include documentation. See our [docs documentation](writing_docs.md) for more information.
- `.bugfix`: use this for bugfixes.
- `.misc`: use this for small maintenance changes that don't need to be communicated such as fixing typos, refactoring code etc.

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/vagrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ workon pulp

## Running tests

Functional and unit tests can be run from vagrant. Integration tests can only be run in [the docker environment](dev/docker_environment.md).
Functional and unit tests can be run from vagrant. Integration tests can only be run in [the docker environment](docker_environment.md).

### Integration Tests

Expand Down
2 changes: 1 addition & 1 deletion docs/usage_guide/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Collection has been successfully published and imported to the Galaxy server dev

### Approval

Once a collection is uploaded, it will either end up in the Published repository, where it will be available for download, or the staging repository where it needs to be approved first depending on what you have configured for [GALAXY_REQUIRE_CONTENT_APPROVAL](/galaxy_ng/config/options#galaxy).
Once a collection is uploaded, it will either end up in the Published repository, where it will be available for download, or the staging repository where it needs to be approved first depending on what you have configured for [GALAXY_REQUIRE_CONTENT_APPROVAL](../config/options.md#galaxy).

If approval is required, click the "Collections > Approval" link in the navigation menu. This will give you a list of newly uploaded collections to review. If signing is enabled, you will also be promted to sign the collection.

Expand Down
2 changes: 1 addition & 1 deletion docs/usage_guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ for any reason an installation from scratch is needed, all the details can be fo

!!! info
This is the recommended installation process for a production ready system. If you are looking
for information on how to install on a development environment see [development setup page](/dev/setup/)
for information on how to install on a development environment see [development setup page](../dev/getting_started.md)

The following provides instructions for installing GalaxyNG on a virtual machine, with an example playbook that installs Pulp and Galaxy NG from PyPi packages.

Expand Down
4 changes: 2 additions & 2 deletions docs/usage_guide/rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ Object roles are assigned to a specific instance of an object, and only grant th

Currently there are two places where object roles are used:

- [Collection namespaces](/galaxy_ng/usage_guide/collections#permissions)
- [Execution Environment namespaces](/galaxy_ng/usage_guide/execution_environments#permissions)
- [Collection namespaces](collections.md#permissions)
- [Execution Environment namespaces](execution_environments.md#permissions)
1 change: 0 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ plugins:
tags_file: tags.md
- search:
lang: en
prebuild_index: true
markdown_extensions:
- tables
- attr_list
Expand Down
Loading