Documentation website work
18 views
Skip to first unread message
Austin Macdonald
Mar 23, 2020, 12:34:00 PM3/23/20
to operator-framework-sdk-dev
We are working to build a documentation website that will replace the in-tree github rendered docs.
The initial bootstrapping is in place, docs are temporarily viewable at operator-sdk.netlify.com. Additionally, all PRs now include a netlify preview build.
- MERGED: https://github.com/operator-framework/operator-sdk/pull/2667
- MERGED: https://github.com/operator-framework/operator-sdk/pull/2679
- existing documentation remains in place under doc/
- a copy of the documentation is in website/content/en/docs/
[Important] Please do not merge new docs changes to doc/ unless it is important. If changes must be made, please make them in both doc/ and website/content/en/docs/. We have an additional check in place to help make sure this works.
The docs in website/content/en/docs now need to be organized by section. This work can be done in parallel, so please pick up an issue if you are comfortable.
- CLI: https://github.com/operator-framework/operator-sdk/issues/2695
- test-framework: https://github.com/operator-framework/operator-sdk/issues/2693
- helm: https://github.com/operator-framework/operator-sdk/issues/2691
- golang: https://github.com/operator-framework/operator-sdk/issues/2690
- ansible: https://github.com/operator-framework/operator-sdk/issues/2689
Additional Info
- The link checker is currently disabled for docs in the website/ dir while content is moved around. A hugo friendly link checker will be added and links fixed after this phase.
- search will be disabled until the docs are hosted in the final location and we enable indexing
Daniel Messer
Mar 26, 2020, 8:56:40 AM3/26/20
to Austin Macdonald, Austin Macdonald, operator-framework-sdk-dev
@Austin Macdonald can we get a section around general workflow? E.g. generate a project, add APIs, generate deep copy, generate CSV, build bundle and then deploy Operator? It overlaps a bit with CLI unless this would be just a pure CLI reference.
--
You received this message because you are subscribed to the Google Groups "operator-framework-sdk-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to operator-framework-...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/operator-framework-sdk-dev/49ed0813-0fab-4372-9001-7b088064d672%40googlegroups.com.
Daniel Messer
He / Him / His
Product Manager OpenShift
Wankelstrasse 5
70563 Stuttgart
 |
Austin Macdonald
Mar 26, 2020, 9:58:31 AM3/26/20
to Daniel Messer, operator-framework-sdk-dev
On Thu, Mar 26, 2020 at 8:56 AM Daniel Messer <dme...@redhat.com> wrote:
@Austin Macdonald can we get a section around general workflow? E.g. generate a project, add APIs, generate deep copy, generate CSV, build bundle and then deploy Operator? It overlaps a bit with CLI unless this would be just a pure CLI reference.
IMO, CLI section should just be a pure reference area. "generate a project, add APIs" belongs in the quickstart for each type. Does "Generate CSG, bundle and deploy" make sense as a top-level guide, or should that also be separated by type?
Daniel Messer
Mar 30, 2020, 8:11:52 AM3/30/20
to Austin Macdonald, operator-framework-sdk-dev
I think a general "concepts" section could include something like this
- running/testing your Operator locally
- publishing your Operator into a catalog
- updating your Operator
- ...
Reply all
Reply to author
Forward
0 new messages