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: Removing errors from documentation #941

Merged
merged 12 commits into from
Dec 15, 2021
Merged

Conversation

HarshCasper
Copy link
Contributor

Description

This PR serves the purpose of fixing docs issues through the website.

@HarshCasper HarshCasper changed the title WIP) DOCS: Removing errors from documentation (WIP) DOCS: Removing errors from documentation Nov 24, 2021
@danlester
Copy link
Contributor

@HarshCasper I also fixed some of these in a recent PR.

I may have approached it differently.

I added 'Keycloak' to the vocab, but not 'keycloak' - and fixed the complaints by using backticks around code, e.g. security.keycloak.

And one or two other rules I decided to demote to warnings instead of errors because I didn't feel they add value to our docs, certainly considering they cause tests to fail if broken.

@HarshCasper HarshCasper changed the title (WIP) DOCS: Removing errors from documentation DOCS: Removing errors from documentation Dec 13, 2021
Copy link
Member

@iameskild iameskild left a comment

Choose a reason for hiding this comment

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

Thanks @HarshCasper for all the clean up! I have added a few suggestions based on my review. The two most suggestions are converting It's to it's when in the middle of a sentence and adding back the s in k9s.

docs/source/admin_guide/upgrade.md Outdated Show resolved Hide resolved
docs/source/dev_guide/minikube.md Outdated Show resolved Hide resolved
docs/source/dev_guide/minikube.md Outdated Show resolved Hide resolved
docs/source/dev_guide/minikube.md Outdated Show resolved Hide resolved
docs/source/dev_guide/minikube.md Outdated Show resolved Hide resolved
docs/source/installation/setup.md Outdated Show resolved Hide resolved
docs/source/installation/setup.md Outdated Show resolved Hide resolved
docs/source/user_guide/dask_gateway.md Outdated Show resolved Hide resolved
docs/source/user_guide/dask_gateway.md Outdated Show resolved Hide resolved
docs/source/user_guide/faq.md Outdated Show resolved Hide resolved
docs/source/dev_guide/minikube.md Outdated Show resolved Hide resolved
docs/source/dev_guide/minikube.md Outdated Show resolved Hide resolved
@iameskild iameskild self-requested a review December 15, 2021 18:51
@iameskild iameskild merged commit fa85147 into main Dec 15, 2021
@iameskild iameskild deleted the docs-update-cleanup branch December 15, 2021 18:51
@HarshCasper HarshCasper linked an issue Dec 15, 2021 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[documentation] Fix Vale errors, warnings and suggestions
3 participants