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

docs: Overhaul Shell Completion & Autocomplete documentation #5701

Merged
merged 10 commits into from Jan 26, 2024

Conversation

Nick-Hope
Copy link
Contributor

@Nick-Hope Nick-Hope commented Jan 17, 2024

The Issue

The 'Shell Completion & Autocomplete' documentation page is difficult to follow and comprehend due to duplication and, in parts, convoluted logic. In particular, there is repetition of the instructions for obtaining the tar archive of completion scripts, and such instructions vary. DDEV version numbers also vary and are outdated in various places.

How This PR Solves The Issue

Overhaul of much of the page for clarification, conciseness, updating of version numbers, and to avoid duplication. In particular, provide instructions for obtaining the tar archive of completion scripts in just one place, and link to it from the individual instructions for specific scripts.

Manual testing instructions

See https://ddev--5701.org.readthedocs.build/en/5701/users/install/shell-completion/

Automated Testing Overview

No tests needed. Just documentation.

Overhaul of much of the page for clarification, updates, and to avoid duplication.
@Nick-Hope Nick-Hope requested a review from a team as a code owner January 17, 2024 07:39
@stasadev
Copy link
Member

stasadev commented Jan 17, 2024

Hi @Nick-Hope,

Thank you, I haven't reviewed this PR yet, just had a quick look at the formatting on the page, some code blocks need to be reformatted, you can view your changes online in the browser:

https://ddev.readthedocs.io/en/latest/developers/testing-docs/#fix-docs-using-web-browser

Once the PR has run its checks, you’ll see an item labeled docs/readthedocs.org:ddev. Click “Details” to review a docs build that includes your changes

Here is the link https://ddev--5701.org.readthedocs.build/en/5701/users/install/shell-completion/

Fix formatting (triple backticks in 3 places).
Try again to fix triple backticks in the code block in "tar Archive of Completion Scripts for Manual Deployment".
Remove indentation in code block in bottom section, so that triple backticks create a fenced code block instead of being rendered.
@Nick-Hope
Copy link
Contributor Author

@stasadev I got there in the end. The triple backticks are not being rendered now. Apologies if my multiple attempts caused you too many notifications.

Copy link
Member

@stasadev stasadev left a comment

Choose a reason for hiding this comment

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

@Nick-Hope,

No problems with notifications 🙂

Thank you for your efforts to make it easier to work with DDEV!

docs/content/users/install/shell-completion.md Outdated Show resolved Hide resolved
docs/content/users/install/shell-completion.md Outdated Show resolved Hide resolved
docs/content/users/install/shell-completion.md Outdated Show resolved Hide resolved
docs/content/users/install/shell-completion.md Outdated Show resolved Hide resolved
docs/content/users/install/shell-completion.md Outdated Show resolved Hide resolved
docs/content/users/install/shell-completion.md Outdated Show resolved Hide resolved
Nick-Hope and others added 6 commits January 24, 2024 11:36
Use correct paths to completions

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
Use relative link to documentation

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
Use relative link to documentation

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
Use relative link to documentation

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
Use relative link to documentation

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
Use relative link to documentation

Co-authored-by: Stanislav Zhuk <stasadev@gmail.com>
Copy link
Member

@stasadev stasadev left a comment

Choose a reason for hiding this comment

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

Thank you!

And for future reference, you can apply all GitHub suggestions in one commit when you view them from the Files changed tab, "Add suggestion to batch" button is available there.

@stasadev stasadev merged commit 16f2a2e into ddev:master Jan 26, 2024
12 checks passed
@Nick-Hope Nick-Hope deleted the patch-1 branch January 27, 2024 03:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants