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

Add documentation #54

Merged
merged 28 commits into from
Apr 15, 2020
Merged

Add documentation #54

merged 28 commits into from
Apr 15, 2020

Conversation

drpaneas
Copy link
Contributor

@drpaneas drpaneas commented Apr 9, 2020

Add documentation

Create documentation for SRE and Developers who want either to
contribute or use the Operator. It adds a "docs" directory
and dumps all the related documents:

 * docs/README          - central TOC overview of the documentation
 * docs/gcpconfig       - instructions for GCP Configuration
 * docs/userstory       - how to use it
 * docs/debug           - tips and tricks
 * docs/api             - api description
 * docs/design          - describes the CRDs
 * docs/building        - instruction for building the project
 * docs/development     - devenv setup
 * docs/troubleshooting - common error during dev cycles
 * docs/analysis        - high-level overview of the code

Part of OSD-3248

@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: drpaneas
To complete the pull request process, please assign mwoodson
You can assign the PR to them by writing /assign @mwoodson in a comment when ready.

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

Create documentation for SRE and Developers who want either to
contribute or use the Operator. It adds a "docs" directory
and dumps all the related documents:

 * docs/README          - central TOC overview of the documentation
 * docs/gcpconfig       - instructions for GCP Configuration
 * docs/userstory       - how to use it
 * docs/debug           - tips and tricks
 * docs/api             - api description
 * docs/design          - describes the CRDs
 * docs/building        - instruction for building the project
 * docs/development     - devenv setup
 * docs/troubleshooting - common error during dev cycles
 * docs/analysis        - high-level overview of the code
drpaneas and others added 3 commits April 15, 2020 15:57
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Copy link
Member

@mmazur mmazur left a comment

Choose a reason for hiding this comment

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

I fixed what jumped out at me.

drpaneas and others added 9 commits April 15, 2020 16:10
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
@drpaneas
Copy link
Contributor Author

I fixed what jumped out at me.

Thank you for your time Mariusz going through the large document. I've approved your suggestions.

drpaneas and others added 7 commits April 15, 2020 17:24
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
drpaneas and others added 8 commits April 15, 2020 17:26
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
Co-Authored-By: Mariusz Mazur <[email protected]>
@mmazur mmazur added the lgtm Indicates that a PR is ready to be merged. label Apr 15, 2020
@mmazur mmazur merged commit 61cdccf into openshift:master Apr 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants