Updated README with TOC #245
Conversation
ddsharpe
changed the title
There was a problem hiding this comment.
So, I think the TOC and breaking out certain sections into other docs is good. The slightly unconventional aspect is that usually the TOC structure and indentations follow the doc. To see what I mean, see the operator user guide, https://github.com/oracle/weblogic-kubernetes-operator/blob/master/site/user-guide.md
However, the TOC doesn't have to follow that rule. What you did is ok but not sure why you excluded these two sections: Model Names and Model Semantics.
Last, I wonder about your use of heading levels. You go from a Head 2 to a Head 4, then back again (I think; it's a little hard to discern from the diff).
In all, I think it's a good start and I'd be willing to look it over again after the merge and see if I can recommend some fine tuning.
ddsharpe
dismissed stale reviews from rakillen and rosemarymarano
via
3a3babe
There was a problem hiding this comment.
Looks great! So helpful.
- the encrypt and validate look like they should go into the model section
- the variable inject should be Model Var...
- Could we have a section (maybe third item under model section) something like 'how to create your model from scratch" and detail how to use validate print usage here, instead of under the validate section
|
Agreed, we need a section for how to create a model from scratch. The current doc is lacking in this topic. The Variable Injection section matches the documentation that existed before this change, as well as the name of the tool. I am not sure why the TOC title should not match. As for the encrypt tool, validate tool, and injection tool, they kind of fit where they are but not really. But, they aren't a perfect fit for the Model section either. I am going to push the changes as is, but I think there is room for improvement with the organization of these model-utility-like tools. |
No description provided.