-
Notifications
You must be signed in to change notification settings - Fork 5
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
docs: Moved YAML Keywords from level 2 to level 1 section new #575
Conversation
@frodehk @HeddaSvendsen @olelod This branch, [ECALC-579-structure-ecalc-docs-new], is replace the old one [ECALC-579-structure-ecalc-docs], for the same updates as follows. Based on the Haldis comments, I made following updates in the eCalc Docs. Change the name of section “Reference Documentation“ to “Keyword and Reference“, which includes sub titles of “eCalc Keywords“, “API Reference“ and “cli_reference“. This name change makes it easy for users to search eCalc keyword information. The CLI part of “cli_reference“ was merged with “Getting Started“ CLI part. So, “cli_reference“ is empty now. It can be removed or rename for something else later after the finial decision. The sub title “API Reference“ is still kept for any reference update later in the eCalc Doc. The sub title “YAML Keywords“ was change to “eCalc Keywords“ to avoid confuse for users. To keep title and sub tile of chapters in consistent formats. |
Nice @equinor-schen. I think we should consider to move all keywords to level 1, as suggested by @halsyl . And also consider to move API reference to Getting started. Moving the keywords can be done quickly, use refactor functionality. Then search "reference/keywords" and replace it with "keywords". |
…itle format adjustment. (cherry picked from commit cc188016f8db39c0e57074045a3d509d2a9ce6cd)
ECALC-579
0a7cf9f
to
c4f9d0a
Compare
ECALC-579
ECALC-579
ECALC-579
ECALC-579
Co-authored-by: Ole Petter Lødøen <opl@equinor.com>
* docs: Restructure eCalc docs moving keywords from level 2 to 1 --------- Co-authored-by: Shi Chen <98941870+equinor-schen@users.noreply.github.com> Co-authored-by: Jostein Solaas <josas@equinor.com> Co-authored-by: Ole Petter Lødøen <opl@equinor.com>
(cherry picked from commit cc188016f8db39c0e57074045a3d509d2a9ce6cd)
Why is this pull request needed?
Documentation structure can be confusing for some users. E.g. placement of yaml keywords, CLI information at two places, API reference etc.
What does this pull request change?
Issues related to this change:
https://equinor-ecalc.atlassian.net/browse/ECALC-579?atlOrigin=eyJpIjoiN2NjM2NkZWI2M2EwNDFhZmFlMzM5OTMyN2ZjMmI3ZTIiLCJwIjoiaiJ9