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

Split documentation for navigation config #365

Merged
merged 3 commits into from
Jan 23, 2019

Conversation

bszwarc
Copy link
Contributor

@bszwarc bszwarc commented Jan 21, 2019

Description

Changes proposed in this pull request:

  • Split navigation configuration into two separate docs.
  • Rename micro front-end to micro frontend.

Related issue(s)
See also #276

@bszwarc bszwarc self-assigned this Jan 21, 2019
@bszwarc bszwarc added WIP Work in progress area/documentation labels Jan 21, 2019
@bszwarc bszwarc added this to the Sprint_Swinka_7 milestone Jan 21, 2019
@bszwarc bszwarc removed the WIP Work in progress label Jan 22, 2019
Copy link
Contributor

@dariadomagala-sap dariadomagala-sap left a comment

Choose a reason for hiding this comment

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

Shouldn't there be a link to navigation-parameters-reference.md file in navigation-configuration.md?

@dariadomagala-sap dariadomagala-sap self-assigned this Jan 22, 2019
Copy link
Contributor

@dariadomagala-sap dariadomagala-sap left a comment

Choose a reason for hiding this comment

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

Look at the comments, but overall looks good.



![Navigation layout](assets/navigation-structure.png)
![Navigation elements](assets/navigation-structure.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if elements is a good word here. I kinda liked layout better :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed it back to layout :)

3. Main content window, where the micro front-end is rendered.
1. Top navigation, which displays the main navigation path.
2. Side navigation, which displays the defined applications.
3. Main content window, which renders the micro frontend.
Copy link

Choose a reason for hiding this comment

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

Are you sure about those commas? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no, I'm gonna remove them.

docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
docs/navigation-configuration.md Outdated Show resolved Hide resolved
@bszwarc bszwarc force-pushed the issue-276-docsplit branch from 9226f6d to 4bc4102 Compare January 23, 2019 09:02
@bszwarc bszwarc merged commit 0146e3c into SAP:master Jan 23, 2019
@bszwarc bszwarc deleted the issue-276-docsplit branch January 23, 2019 09:03
stanleychh pushed a commit to stanleychh/luigi that referenced this pull request Dec 30, 2021
* Split documentation for navigation config
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.

3 participants