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

Add documentation for kopia repository server controller workflow #2077

Open
wants to merge 35 commits into
base: master
Choose a base branch
from
Open

Add documentation for kopia repository server controller workflow #2077

wants to merge 35 commits into from

Conversation

kale-amruta
Copy link
Contributor

@kale-amruta kale-amruta commented May 26, 2023 •
edited
Loading

Change Overview

This PR adds documentation for kopia repository server controller workflow in kanister

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

  • fixes #issue-number

Test Plan

  • 💪 Manual
  • ⚡ Unit test
  • 💚 E2E

@github-actions
Copy link

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 May 26, 2023
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 6e6adda to 75eebd9 Compare May 26, 2023 08:39
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 95ffff0 to 0f08325 Compare May 30, 2023 14:52
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 0d74e54 to 4e4b53d Compare May 31, 2023 12:19
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 598f814 to 83d4751 Compare May 31, 2023 13:09
PrasadG193
PrasadG193 reviewed Jun 1, 2023
View reviewed changes
docs/architecture.rst Outdated Show resolved Hide resolved
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 023cbe7 to c6fc2dd Compare June 1, 2023 12:12
@kale-amruta kale-amruta marked this pull request as draft June 2, 2023 09:35
uday3927
uday3927 reviewed Jun 2, 2023
View reviewed changes
Copy link

@uday3927 uday3927 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Added a few comments. Need to look at the remaining portion of the documentation.

docs/Tutorial/tutorial_repositoryserver.rst Outdated Show resolved Hide resolved
docs/Tutorial/tutorial_repositoryserver.rst Outdated Show resolved Hide resolved
docs/Tutorial/tutorial_repositoryserver.rst Outdated Show resolved Hide resolved
docs/Tutorial/tutorial_repositoryserver.rst Outdated Show resolved Hide resolved
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from c0ec30c to 54d2c11 Compare June 5, 2023 07:07
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 989f65c to fa158e4 Compare June 5, 2023 07:10
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from c0a855c to b46d334 Compare June 5, 2023 15:45
@kale-amruta kale-amruta marked this pull request as ready for review June 6, 2023 12:32
@pavannd1 pavannd1 self-requested a review June 7, 2023 05:21
@pavannd1
Copy link
Contributor

pavannd1 commented Jun 7, 2023

Review WIP. Will post my comments tomorrow.

@uday3927
Copy link

uday3927 commented Jun 8, 2023

@kale-amruta I am reviewing this. I will post the comments today.

@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 08d0080 to d519fbf Compare June 8, 2023 07:27
uday3927
uday3927 reviewed Jun 13, 2023
View reviewed changes
Copy link

@uday3927 uday3927 left a comment

Choose a reason for hiding this comment

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

Added comments.

docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
uday3927
uday3927 reviewed Jun 13, 2023
View reviewed changes
Copy link

@uday3927 uday3927 left a comment

Choose a reason for hiding this comment

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

Added comments.

docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
@pavannd1
Copy link
Contributor

@kale-amruta I haven't had a chance to get back to reviewing this. I agree with the FAQ section but that should be considered an enhancement to Kanister docs in general. Let's address that separately later.

One of the things I noticed was the use of Kopia and kopia inconsistently in the docs. One convention to follow (@uday3927 can correct me if I'm wrong) is to use Kopia when referring to the project/tool and kopia when referring to the CLI.

@uday3927
Copy link

@pavannd1 Yes, Pavan. We can use Kopia when referring to the official name of the product or tool or emphasizing the specific name or brand.
We can use kopia when mentioning the project or tool in a general or non-emphasized context such as referring to the CLI.

@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 2f7f253 to 9ac8e20 Compare August 3, 2023 06:22
uday3927
uday3927 reviewed Aug 8, 2023
View reviewed changes
Copy link

@uday3927 uday3927 left a comment

Choose a reason for hiding this comment

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

I provided the feedback.
Please let me know if you have any concerns.

docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
@kale-amruta kale-amruta force-pushed the kopiaRepositoryServerWorkflowDocs branch from 50dfbfc to 0454234 Compare September 26, 2023 06:49
uday3927
uday3927 reviewed Oct 11, 2023
View reviewed changes
Copy link

@uday3927 uday3927 left a comment

Choose a reason for hiding this comment

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

Added comments.

docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
uday3927
uday3927 reviewed Oct 17, 2023
View reviewed changes
Copy link

@uday3927 uday3927 left a comment

Choose a reason for hiding this comment

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

A few comments are added.

docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/tutorials/tutorial_with_repositoryserver.rst Outdated Show resolved Hide resolved
docs/install.rst Outdated Show resolved Hide resolved
docs/architecture.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@uday3927 uday3927 uday3927 left review comments

@pavannd1 pavannd1 Awaiting requested review from pavannd1

@PrasadG193 PrasadG193 Awaiting requested review from PrasadG193

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
frozen
Projects
Kanister
In Progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@kale-amruta @pavannd1 @uday3927 @PrasadG193 @r4rajat