Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

Spliting index.md file for 1.9.x #454

Merged
merged 4 commits into from
Feb 13, 2020
Merged

Conversation

iamveritas
Copy link
Contributor

@iamveritas iamveritas commented Feb 6, 2020

Change Description

  1. Spliting index.md file, the content thus moved into new sections, index.md has link to those new sections
  2. Fix outdated links
  3. Small corrections on emphasizing terms, e.g. system contracts or system accounts
  4. Some re-ordering of the sections was done due to introductions of the new ones
  5. No new content added, thus another tech review or content review is not needed; however annotations of the system contract's classes were added or updated.
  6. To avoid double listing of system contracts (in reference doc tree and under core concepts tree) on the main navigation, each system contract class was annotated more thoroughly; these annotations will make their way into the reference doc content. The core concepts subsection in the navigation tree is not needed anymore, core concept are covered by index.md with link to the reference doc

Fixes #451

Deployment Changes

  • Deployment Changes

API Changes

  • API Changes

Documentation Additions

  • Documentation Additions

…ex.md has link to those new sections

Fix outdated links
Small corrections on emphasizing terms, e.g. system contracts or system accounts
Some re-ordering of the sections was done due to introductions of the new ones
No new content added, thus another tech review or content review is not needed; however annotations of the system contract's classes were added or updated.
To avoid double listing of system contracts (in reference doc tree and under core concepts tree) on the main navigation, each system contract class was annotated more thoroughly; these annotations will make their way into the reference doc content. The core concepts subsection in the navigation tree is not needed anymore, core concept are covered by index.md with link to the reference doc
@iamveritas iamveritas self-assigned this Feb 6, 2020
@iamveritas iamveritas added the documentation Requires attention of documentation team. e.g. documentation is expected to be generated. label Feb 6, 2020
@iamveritas iamveritas requested a review from dskvr February 6, 2020 21:36
Copy link
Contributor

@dskvr dskvr left a comment

Choose a reason for hiding this comment

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

Builds great, didn't detect any broken links 👍

@iamveritas iamveritas changed the title Spliting index.md file, the content thus moved into new sections, ind… Spliting index.md file Feb 7, 2020
@iamveritas iamveritas changed the title Spliting index.md file Spliting index.md file for 1.9.x Feb 7, 2020
@iamveritas iamveritas marked this pull request as ready for review February 11, 2020 16:56
Copy link
Contributor

@johndebord johndebord left a comment

Choose a reason for hiding this comment

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

LGTM.

@arhag arhag merged commit 2d02f4f into release/1.9.x Feb 13, 2020
@arhag arhag deleted the docs/1.9.x-split-index-md branch February 13, 2020 00:16
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Requires attention of documentation team. e.g. documentation is expected to be generated.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants