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

docs: Moved YAML Keywords from level 2 to level 1 section new #575

Merged
merged 9 commits into from
Aug 30, 2024

Conversation

frodehk
Copy link
Contributor

@frodehk frodehk commented Aug 23, 2024

(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?

  • Move API reference section from Reference Documentation to Getting Started
  • Move CLI reference section from Reference Documentation to Getting Started CLI. Separate section at same level as FAQ / Troubleshooting
  • Move all keywords up to level 1, i.e. Reference Documentation not needed anymore

Issues related to this change:

https://equinor-ecalc.atlassian.net/browse/ECALC-579?atlOrigin=eyJpIjoiN2NjM2NkZWI2M2EwNDFhZmFlMzM5OTMyN2ZjMmI3ZTIiLCJwIjoiaiJ9

@frodehk frodehk requested a review from a team as a code owner August 23, 2024 10:21
@equinor-schen
Copy link
Contributor

@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.

@frodehk
Copy link
Contributor Author

frodehk commented Aug 24, 2024

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".

@frodehk frodehk requested a review from a team as a code owner August 26, 2024 10:14
equinor-schen and others added 3 commits August 26, 2024 12:22
…itle format adjustment.

(cherry picked from commit cc188016f8db39c0e57074045a3d509d2a9ce6cd)
@frodehk frodehk force-pushed the ECALC-579-structure-ecalc-docs-new branch from 0a7cf9f to c4f9d0a Compare August 26, 2024 10:22
Co-authored-by: Ole Petter Lødøen <opl@equinor.com>
@frodehk frodehk merged commit 145deab into main Aug 30, 2024
9 checks passed
@frodehk frodehk deleted the ECALC-579-structure-ecalc-docs-new branch August 30, 2024 12:09
frodehk added a commit that referenced this pull request Sep 16, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants