Skip to content

Updates user guide page names and links#3904

Merged
lasomethingsomething merged 42 commits intomainfrom
docs-changes-jul-31
Aug 9, 2023
Merged

Updates user guide page names and links#3904
lasomethingsomething merged 42 commits intomainfrom
docs-changes-jul-31

Conversation

@lasomethingsomething
Copy link
Copy Markdown
Contributor

Updated a number of page names that were vague in the context of other pages (GitOpsSets, Pipelines, GitOps Run sections), and fixed resulting broken links. Minor punctuation and other fixes scattered throughout. PR also updates the sidebars.js for main and last version (0.28.0) and the 0.28.0 docs.

The linter snagged on a reference in the "Install WGE" page to our Helm reference page, but I didn't edit that page. The link looks fine, so not sure what's going on.

@lasomethingsomething lasomethingsomething self-assigned this Jul 31, 2023
@lasomethingsomething lasomethingsomething added team/wild-watermelon user-guide Improvements to docs at https://docs.gitops.weave.works/ labels Jul 31, 2023
@yiannistri yiannistri force-pushed the docs-changes-jul-31 branch 3 times, most recently from bcca2bc to e041bd4 Compare August 2, 2023 06:43
Comment thread website/docs/configuration/tls.md
Comment thread website/docs/gitopssets/gitopssets-intro.mdx Outdated
Copy link
Copy Markdown
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

Reviewed the section within website/docs as i assumed is the main part and the part on v0.28 are backporting or adjusting changes but not new content.

it looks generally good, added small comments to enhance it.

Also added a question about the cert-manager section within tls. it seems there is something missing in terms of scope or content.

Comment thread website/docs/pipelines/pipelines-getting-started.mdx Outdated
Comment thread website/docs/configuration/tls.md Outdated
Comment thread website/docs/configuration/tls.md Outdated
Comment thread website/docs/pipelines/pipelines-templates.mdx Outdated
Copy link
Copy Markdown
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

replied and expanded to the open items.

Comment thread website/docs/configuration/tls.md Outdated
Comment thread website/docs/pipelines/pipelines-getting-started.mdx Outdated
@enekofb enekofb self-requested a review August 8, 2023 07:00
Copy link
Copy Markdown
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

Thanks for taking into consideration the comments.

The cert-manager section seems still having some changes in this PR. Not sure if that is expected. Asked in the thread,

Regarding aligning getting started, there are some other docs that might require the same alignment. Suggested in this comment. For example this suggestion. There might be other ones. It could be good to review to ensure we have consistency.

Last comment, is given we are in v0.29 whether makes sense to just dont backport the changes of this PR to v0.28 or if there is anything in particular we are looking in that version.

Comment thread website/docs/configuration/tls.md Outdated
Comment thread website/docs/gitops-run/gitops-run-get-started.mdx Outdated
@lasomethingsomething lasomethingsomething force-pushed the docs-changes-jul-31 branch 3 times, most recently from 257af65 to 599a8a0 Compare August 8, 2023 17:13
@lasomethingsomething lasomethingsomething force-pushed the docs-changes-jul-31 branch 3 times, most recently from 9d7260d to 76523ba Compare August 8, 2023 18:05
@lasomethingsomething lasomethingsomething force-pushed the docs-changes-jul-31 branch 2 times, most recently from 02cf43e to 3179b5c Compare August 9, 2023 08:03
@lasomethingsomething lasomethingsomething force-pushed the docs-changes-jul-31 branch 3 times, most recently from 2fcc9af to 714d860 Compare August 9, 2023 08:07
yiannistri and others added 12 commits August 9, 2023 10:07
Co-authored-by: Yiannis <8741709+yiannistri@users.noreply.github.com>
Moves cert-manager guide text to page
Fix bullet points
Co-authored-by: Eneko Fernández <12957664+enekofb@users.noreply.github.com>
Co-authored-by: Eneko Fernández <12957664+enekofb@users.noreply.github.com>
Co-authored-by: Eneko Fernández <12957664+enekofb@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@enekofb enekofb left a comment

Choose a reason for hiding this comment

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

Approved: thanks for the patient to take the suggestions.

Before merging please check the build job. I think that you dont need this change or it is left behind from cleanup

It would be great to squash and merge the branch or squash the commits before merging

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team/wild-watermelon user-guide Improvements to docs at https://docs.gitops.weave.works/

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants