From ee807ad9511c0ea78e1bc79eddf08c187aa6b69c Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Mon, 14 Aug 2023 12:40:45 -0400 Subject: [PATCH 1/2] No-Issue --- docs/config/options.md | 6 +++--- docs/dev/docker_environment.md | 2 +- docs/dev/getting_started.md | 8 ++++---- docs/dev/vagrant.md | 2 +- docs/usage_guide/collections.md | 2 +- docs/usage_guide/installation.md | 2 +- docs/usage_guide/rbac.md | 4 ++-- mkdocs.yml | 1 - 8 files changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/config/options.md b/docs/config/options.md index 5b09a7b64c..24d8a04f4a 100644 --- a/docs/config/options.md +++ b/docs/config/options.md @@ -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 @@ -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` | @@ -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 diff --git a/docs/dev/docker_environment.md b/docs/dev/docker_environment.md index 2001894fdd..22e2b7d51b 100644 --- a/docs/dev/docker_environment.md +++ b/docs/dev/docker_environment.md @@ -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 diff --git a/docs/dev/getting_started.md b/docs/dev/getting_started.md index 751d9be13e..6f449a14bd 100644 --- a/docs/dev/getting_started.md +++ b/docs/dev/getting_started.md @@ -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 @@ -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 @@ -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 `.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. diff --git a/docs/dev/vagrant.md b/docs/dev/vagrant.md index 2282f53317..13679d4b91 100644 --- a/docs/dev/vagrant.md +++ b/docs/dev/vagrant.md @@ -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 diff --git a/docs/usage_guide/collections.md b/docs/usage_guide/collections.md index a41436594b..7720bd927f 100644 --- a/docs/usage_guide/collections.md +++ b/docs/usage_guide/collections.md @@ -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. diff --git a/docs/usage_guide/installation.md b/docs/usage_guide/installation.md index 58c45e0be8..4aa698eb61 100644 --- a/docs/usage_guide/installation.md +++ b/docs/usage_guide/installation.md @@ -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. diff --git a/docs/usage_guide/rbac.md b/docs/usage_guide/rbac.md index 8b15ff7a0e..e399410cc4 100644 --- a/docs/usage_guide/rbac.md +++ b/docs/usage_guide/rbac.md @@ -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) diff --git a/mkdocs.yml b/mkdocs.yml index 7047642e72..0af18d83b2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,7 +72,6 @@ plugins: tags_file: tags.md - search: lang: en - prebuild_index: true markdown_extensions: - tables - attr_list From 6f28c94a06e8b136f5bcb9c8187e93070fd212bf Mon Sep 17 00:00:00 2001 From: Bruno Rocha Date: Thu, 17 Aug 2023 15:11:37 +0100 Subject: [PATCH 2/2] Required CI checks must not be ignored when docs changed Required CI checks was being ignored when changes are docs only No-Issue --- .github/workflows/ci_oci-env-integration.yml | 4 ---- .../workflows/deactivated/ci_standalone-certified-sync.yml | 4 ---- .../workflows/deactivated/ci_standalone-iqe-rbac-tests.yml | 4 ---- .github/workflows/deactivated/ci_standalone-rbac-on-repos.yml | 4 ---- .github/workflows/deactivated/ci_standalone-rbac-roles.yml | 4 ---- .github/workflows/deactivated/ci_standalone-x-repo-search.yml | 4 ---- 6 files changed, 24 deletions(-) diff --git a/.github/workflows/ci_oci-env-integration.yml b/.github/workflows/ci_oci-env-integration.yml index d8097f734b..9785e94fb0 100644 --- a/.github/workflows/ci_oci-env-integration.yml +++ b/.github/workflows/ci_oci-env-integration.yml @@ -4,10 +4,6 @@ on: pull_request: branches: - '**' - paths-ignore: - - 'docs/**' - - 'mkdocs.yml' - - 'CHANGES/**' push: branches: - '**' diff --git a/.github/workflows/deactivated/ci_standalone-certified-sync.yml b/.github/workflows/deactivated/ci_standalone-certified-sync.yml index 1eab6662b5..a8d9c07916 100644 --- a/.github/workflows/deactivated/ci_standalone-certified-sync.yml +++ b/.github/workflows/deactivated/ci_standalone-certified-sync.yml @@ -4,10 +4,6 @@ on: pull_request: branches: - '**' - paths-ignore: - - 'docs/**' - - 'mkdocs.yml' - - 'CHANGES/**' push: branches: - '**' diff --git a/.github/workflows/deactivated/ci_standalone-iqe-rbac-tests.yml b/.github/workflows/deactivated/ci_standalone-iqe-rbac-tests.yml index a09271c520..37b51f2d88 100644 --- a/.github/workflows/deactivated/ci_standalone-iqe-rbac-tests.yml +++ b/.github/workflows/deactivated/ci_standalone-iqe-rbac-tests.yml @@ -4,10 +4,6 @@ on: pull_request: branches: - '**' - paths-ignore: - - 'docs/**' - - 'mkdocs.yml' - - 'CHANGES/**' push: branches: - '**' diff --git a/.github/workflows/deactivated/ci_standalone-rbac-on-repos.yml b/.github/workflows/deactivated/ci_standalone-rbac-on-repos.yml index 09d61bf0cf..eb0c004e52 100644 --- a/.github/workflows/deactivated/ci_standalone-rbac-on-repos.yml +++ b/.github/workflows/deactivated/ci_standalone-rbac-on-repos.yml @@ -4,10 +4,6 @@ on: pull_request: branches: - '**' - paths-ignore: - - 'docs/**' - - 'mkdocs.yml' - - 'CHANGES/**' push: branches: - '**' diff --git a/.github/workflows/deactivated/ci_standalone-rbac-roles.yml b/.github/workflows/deactivated/ci_standalone-rbac-roles.yml index 4ee7583db6..2248bf1e5d 100644 --- a/.github/workflows/deactivated/ci_standalone-rbac-roles.yml +++ b/.github/workflows/deactivated/ci_standalone-rbac-roles.yml @@ -4,10 +4,6 @@ on: pull_request: branches: - '**' - paths-ignore: - - 'docs/**' - - 'mkdocs.yml' - - 'CHANGES/**' push: branches: - '**' diff --git a/.github/workflows/deactivated/ci_standalone-x-repo-search.yml b/.github/workflows/deactivated/ci_standalone-x-repo-search.yml index 6ecca13564..19110ecac6 100644 --- a/.github/workflows/deactivated/ci_standalone-x-repo-search.yml +++ b/.github/workflows/deactivated/ci_standalone-x-repo-search.yml @@ -4,10 +4,6 @@ on: pull_request: branches: - '**' - paths-ignore: - - 'docs/**' - - 'mkdocs.yml' - - 'CHANGES/**' push: branches: - '**'