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

Update Docs #1528

Merged
merged 6 commits into from
Jul 7, 2022
Merged

Update Docs #1528

merged 6 commits into from
Jul 7, 2022

Conversation

ihcsim
Copy link
Contributor

@ihcsim ihcsim commented Jun 30, 2022

Change Overview

This PR introduces the following documentation updates:

  1. Simplify installation steps
  2. Remove 'usage' section and promote its subsections to main sections
  3. Add 'Next Step' to tutorial to point to example Helm charts on GitHub
  4. Remove obsolete Helm instructions page
  5. Remove redundant prefix in page titles
  6. Update copyright info. in footer

Signed-off-by: Ivan Sim ivan.sim@kasten.io

Pull request type

Please check the type of change your PR introduces:

  • 🚧 Work in Progress
  • 🌈 Refactoring (no functional changes, no api changes)
  • 🐹 Trivial/Minor
  • 🐛 Bugfix
  • 🌻 Feature
  • 🗺️ Documentation
  • 🤖 Test

Issues

Fix #1326

Test Plan

Not required - only doc changes.

1. Simplify installation steps
2. Remove 'usage' section and promote its subsections to main sections
3. Add 'next step' to tutorial
4. Remove obsolete Helm instructions page
5. Remove redundant prefix in page titles
6. Update copyright info. in footer

Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
@github-actions
Copy link
Contributor

Thanks for submitting this pull request 🎉. The team will review it soon and get back to you.

If you haven't already, please take a moment to review our project contributing guideline and Code of Conduct document.

@infraq infraq added this to In Progress in Kanister Jun 30, 2022
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Copy link
Contributor

@pavannd1 pavannd1 left a comment

Choose a reason for hiding this comment

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

Some nits

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/tutorial.rst Outdated Show resolved Hide resolved
ihcsim and others added 2 commits July 7, 2022 10:18
Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Kanister automation moved this from In Progress to Reviewer approved Jul 7, 2022
Copy link
Contributor

@pavannd1 pavannd1 left a comment

Choose a reason for hiding this comment

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

One minor suggestion but looks good otherwise 👍🏼

@ihcsim ihcsim added the kueue label Jul 7, 2022
@mergify mergify bot merged commit 0c3c45d into master Jul 7, 2022
Kanister automation moved this from Reviewer approved to Done Jul 7, 2022
@mergify mergify bot deleted the docs branch July 7, 2022 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

Successfully merging this pull request may close these issues.

Remove/Update stale documentation
3 participants