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

Cleanup docs structure and add open source checklist requirements #1061

Merged
merged 11 commits into from
May 18, 2020

Conversation

jananivMS
Copy link
Contributor

@jananivMS jananivMS commented May 15, 2020

Closes #609
Closes #1066
Also prepares the repo for #1023

What this PR does / why we need it:

  • Need to add the required files in root as per the open source checklist.
  • Also used this to make the docs more cleaner in preparation for open sourcing
  • Updated ManagedIdentity docs to use the script for simplicity
  • There's still consolidation to be done for the deployment doc based on helm but that will be handled as part of Task: Consolidate docs to be more concise and readable (merge helm readme) #1023

Special notes for your reviewer:
Ensure links to other pages work well in all pages

How does this PR make you feel:
gif

If applicable:

  • this PR contains documentation
  • this PR contains tests

@jananivMS jananivMS requested a review from frodopwns May 15, 2020 14:43
Copy link
Contributor

@frodopwns frodopwns left a comment

Choose a reason for hiding this comment

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

some comments I had while reviewing

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/howto/deploy.md Outdated Show resolved Hide resolved
docs/howto/helmdeploy.md Show resolved Hide resolved
docs/howto/newoperatorguide.md Outdated Show resolved Hide resolved
docs/howto/newoperatorguide.md Outdated Show resolved Hide resolved
docs/howto/newoperatorguide.md Outdated Show resolved Hide resolved
docs/howto/newoperatorguide.md Outdated Show resolved Hide resolved
@jananivMS jananivMS requested a review from frodopwns May 16, 2020 05:00
@jananivMS
Copy link
Contributor Author

@frodopwns Addressed your comments, this is ready for re-review

Copy link
Contributor

@frodopwns frodopwns left a comment

Choose a reason for hiding this comment

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

looks good

@jananivMS jananivMS merged commit b7dc612 into Azure:master May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants