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

fix(docs): remove workflow-controller-configmap.yaml self reference #12654

Merged

Conversation

agilgur5
Copy link

@agilgur5 agilgur5 commented Feb 11, 2024

Fixes #12446 (comment)

Motivation

Modifications

  • remove self-reference comment at the top of docs/workflow-controller-configmap.yaml on main

Verification

n/a, as it's rendered raw in the docs

I double-checked that this was not present in the release-3.4 and release-3.5 docs, so no back-porting needed

- this was erroneously added to the `main` branch in d1cae63
  - it should only be on the `gh-pages` branch, for which all HTML pages redirect to ReadTheDocs now, but this YAML could not be, so we added this comment
- on the `main` branch, this is a confusing as it is a self-reference
  - https://argo-workflows.readthedocs.io/en/latest/workflow-controller-configmap.yaml currently points to itself

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs prioritized-review For members of the Sustainability Effort labels Feb 11, 2024
@agilgur5 agilgur5 requested a review from jmeridth February 11, 2024 01:20
@isubasinghe isubasinghe enabled auto-merge (squash) February 11, 2024 09:49
Copy link
Member

@isubasinghe isubasinghe left a comment

Choose a reason for hiding this comment

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

LGTM

@isubasinghe isubasinghe merged commit 130417b into argoproj:main Feb 11, 2024
17 checks passed
@agilgur5 agilgur5 deleted the fix-docs-remove-configmap-self-reference branch February 11, 2024 17:30
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 27, 2024
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 27, 2024
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 27, 2024
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Feb 28, 2024
…argoproj#12654)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Isitha Subasinghe <isubasinghe@student.unimelb.edu.au>
isubasinghe pushed a commit to isubasinghe/argo-workflows that referenced this pull request Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs prioritized-review For members of the Sustainability Effort
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants