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.

Sign up for GitHub

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

Jump to bottom

Fix broken reference to FAQ #79621

Merged
merged 2 commits into from Jan 10, 2023
Merged

Fix broken reference to FAQ #79621

merged 2 commits into from Jan 10, 2023

Conversation

runejuhl
Copy link
Contributor

SUMMARY

The "validate" documentation fragment refers to a section called "Complex configuration validation" in the FAQ, but this section doesn't exist under that name, but rather under "The 'validate' option is not enough for my needs, what do I do?". This PR fixes the reference.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

"validate" documentation fragment

ADDITIONAL INFORMATION

None

@ansibot ansibot added affects_2.15 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. small_patch labels Dec 20, 2022
@ansibot
Copy link
Contributor

ansibot commented Dec 20, 2022

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/plugins/doc_fragments/validate.py:19:161: E501: line too long (208 > 160 characters)

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Dec 20, 2022
@ansibot ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Dec 20, 2022
@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Dec 28, 2022
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Jan 3, 2023
oraNod
oraNod suggested changes Jan 4, 2023
View reviewed changes
Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@runejuhl Thanks for the fix but the syntax here leads to a malformed link when I build the docs.

image

lib/ansible/plugins/doc_fragments/validate.py Outdated Show resolved Hide resolved
@ansibot ansibot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Jan 4, 2023
@oraNod oraNod self-requested a review January 10, 2023 13:01
@ansibot ansibot removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Jan 10, 2023
@ansibot
Copy link
Contributor

ansibot commented Jan 10, 2023

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/plugins/doc_fragments/validate.py:19:161: E501: line too long (187 > 160 characters)

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 10, 2023
@ansibot ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jan 10, 2023
@oraNod oraNod merged commit 602824d into ansible:devel Jan 10, 2023
@oraNod
Copy link
Contributor

oraNod commented Jan 10, 2023

Thanks @runejuhl

@ansible ansible locked and limited conversation to collaborators Jan 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@oraNod oraNod oraNod approved these changes

Assignees
No one assigned
Labels
affects_2.15 docs This issue/PR relates to or includes documentation. new_contributor This PR is the first contribution by a new community member. small_patch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@runejuhl @ansibot @oraNod @bcoca