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

Fixes typos #1557

Merged
merged 5 commits into from
Feb 8, 2023
Merged

Fixes typos #1557

merged 5 commits into from
Feb 8, 2023

Conversation

rachfop
Copy link
Contributor

@rachfop rachfop commented Jan 19, 2023 •
edited
Loading

Doc fixes

  1. Fixes typos.
  2. Removes trailing white space.
  3. Cleaned up sentences.
  4. Formatted code samples.

Doc build site

For the docs site to build:

  1. bundle install
  2. bundle update --bundler
  3. bundle add webrick
  4. bundle exec jekyll serve .

Dob build errors

For the error:
Calling DidYouMean::SPELL_CHECKERS.merge!(error_name => spell_checker)' has been deprecated.
I used bundle update --bundler to fix it.

For the error:
require: cannot load such file -- webrick (LoadError)

I used bundle add webrick to fix it.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jan 19, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: rachfop / name: Patrick Rachford (6e6a761)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jan 19, 2023
@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 19, 2023
AhmedGrati
AhmedGrati suggested changes Jan 21, 2023
View reviewed changes
Copy link
Contributor

@AhmedGrati AhmedGrati left a comment

Choose a reason for hiding this comment

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

An awesome contribution that would take our documentation to the next level 🤩! Just some minor changes that need to be applied.

docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/architecture.md Outdated Show resolved Hide resolved
docs/integrations.md Outdated Show resolved Hide resolved
docs/maven-example.md Outdated Show resolved Hide resolved
docs/user-guide.md Outdated Show resolved Hide resolved
docs/user-guide.md Outdated Show resolved Hide resolved
docs/user-guide.md Outdated Show resolved Hide resolved
@cdrage
Copy link
Member

cdrage commented Jan 22, 2023

Hi! Are you able to only make the changes to the docs and not the assets folder? It seems like this PR was ran through an auto spellcheck program and made changes to the .js files which are not necessary.

We also do not require webrick (and GitHub does not allow this for hosting).

@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 23, 2023
@rachfop rachfop requested review from AhmedGrati and removed request for kadel and hangyan January 23, 2023 16:35
cdrage
cdrage requested changes Jan 23, 2023
View reviewed changes
go.mod
@@ -72,6 +71,7 @@ require (
golang.org/x/text v0.6.0 // indirect
gopkg.in/inf.v0 v0.9.1 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
Copy link
Member

Choose a reason for hiding this comment

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

This is a docs PR and shouldn't be touching go.mod

Copy link
Contributor Author

@rachfop rachfop Jan 23, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Also we recommend you to execute go mod tidy before sending a pull request.

I ran go mod tidy from your contributing guidelines section. But, yes I can undo this.

docs/js/background.js Outdated
var bgArray = ['1.jpg', '2.jpg', '3.jpg', '4.jpg', '5.jpg'];
var path = '../img/background/';

var bgArray = ["1.jpg", "2.jpg", "3.jpg", "4.jpg", "5.jpg"];
Copy link
Member

Choose a reason for hiding this comment

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

Please undo changes to these files in the js/* folder

docs/js/icons.js Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 24, 2023
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 1, 2023
AhmedGrati
AhmedGrati reviewed Feb 7, 2023
View reviewed changes
Copy link
Contributor

@AhmedGrati AhmedGrati left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you @rachfop.

cdrage
cdrage requested changes Feb 7, 2023
View reviewed changes
Copy link
Member

@cdrage cdrage left a comment

Choose a reason for hiding this comment

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

Please rebase against master / delete the docs/js/icons.js and docs/js/background.js files which are included in this PR

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rachfop
Once this PR has been reviewed and has the lgtm label, please assign ngtuna for approval by writing /assign @ngtuna in a comment. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Feb 8, 2023
@k8s-ci-robot k8s-ci-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Feb 8, 2023
@cdrage
Copy link
Member

cdrage commented Feb 8, 2023

Thanks for updating! CI is broken at the moment so I'm going to just merge this in as-is.

@cdrage cdrage merged commit 35a4306 into kubernetes:main Feb 8, 2023
@rachfop rachfop deleted the fix-typos branch February 8, 2023 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AhmedGrati AhmedGrati AhmedGrati requested changes

@cdrage cdrage cdrage requested changes

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rachfop @cdrage @k8s-ci-robot @AhmedGrati