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(docs): correct duplicated title in h1 and title tags in redirecting gh-pages branch #12500

Merged
merged 1 commit into from
Jan 17, 2024
Merged

fix(docs): correct duplicated title in h1 and title tags in redirecting gh-pages branch #12500

merged 1 commit into from
Jan 17, 2024

Conversation

agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Jan 13, 2024 •
edited
Loading

Fixes #12443 (comment) and #12443 (comment)

Motivation

  • h1 erroneously had page_heading - Argo Workflows - The workflow engine for Kubernetes when it should just be page_heading

  • title erroneously had the above plus another - Argo Workflows - The workflow engine for Kubernetes after it

  • also, proposals were previously unintentionally included in the docs site, but they should only be on GitHub

    • they're explicitly excluded in future builds (per chore: move documentation to readthedocs #12360 (this line))
    • they also weren't configured to show up anywhere in the ToC etc in the mkdocs.yml
      • but they would show up in search, unintentionally, as they did exist on the old docs site

Modifications

  1. Find+Replace on " - Argo Workflows - The workflow engine for Kubernetes</h1>" with "</h1>"
  2. Find+Replace on " - Argo Workflows - The workflow engine for Kubernetes - Argo Workflows - The workflow engine for Kubernetes" with " - Argo Workflows - The workflow engine for Kubernetes"
  3. rm -rf proposals/

Verification

  • Checked a handful of individual docs manually
  • Made sure that the previous phrases didn't exist anymore with another Find

@agilgur5
fix(docs): correct duplicated title in h1 and title tags
ad31de7 
- `h1` erroneously had `page_heading - Argo Workflows - The workflow engine for Kubernetes` when it should just be `page_heading`
- `title` erroneously had the above plus another ` - Argo Workflows - The workflow engine for Kubernetes` after it

- also, `proposals` were previously unintentionally included in the docs site, but they should only be on GitHub
  - they're explicitly excluded in future builds (per e921056)
  - they also weren't configured to show up anywhere in the ToC etc in the `mkdocs.yml`

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Jan 13, 2024
@agilgur5 agilgur5 mentioned this pull request Jan 13, 2024
Merged
1 task
jmeridth
jmeridth approved these changes Jan 13, 2024
View reviewed changes
Copy link
Member

@jmeridth jmeridth left a comment

Choose a reason for hiding this comment

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

Reviewed over half. Looks good. Sorry for the regression. Cheers.

@agilgur5 agilgur5 added the prioritized-review For members of the Sustainability Effort label Jan 13, 2024
@jmeridth jmeridth mentioned this pull request Jan 13, 2024
Merged
@juliev0 juliev0 merged commit a0e37ba into argoproj:gh-pages Jan 17, 2024
3 checks passed
@agilgur5 agilgur5 deleted the gh-pages-fix-title-h1-proposals branch January 17, 2024 23:26
@agilgur5 agilgur5 mentioned this pull request Feb 1, 2024
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmeridth jmeridth jmeridth approved these changes

@terrytangyuan terrytangyuan Awaiting requested review from terrytangyuan

Assignees
No one assigned
Labels
area/docs Incorrect, missing, or mistakes in docs prioritized-review For members of the Sustainability Effort
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@agilgur5 @jmeridth @juliev0