NIFI-12540 Restructure Documentation and Guides #81
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added Rewrite Rules for historical links - Added linking to Download sections - Removed download links from separate pages - Moved Guides under Documentation directory - Added Version 1 and Version 2 directories under Documentation - Added MiNiFi C++ and Java paragraphs - Moved Videos to Wiki page - Renamed MiNiFi pages associated with Java Agent version
james-elliott
suggested changes
Dec 22, 2023
content/development/_index.md
Outdated
Comment on lines
13
to
16
| - [Contributing](https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide) | ||
| - [Commit and Release Signing]({{< ref "documentation/guides/signing" >}}) | ||
| - [Developing](https://nifi.apache.org/documentation/nifi-{{< param currentProjectVersion >}}/html/developer-guide.html) | ||
| - [Licensing]({{< ref "documentation/guides/licensing" >}}) |
There was a problem hiding this comment.
We should mark the external links here with an icon
content/documentation/_index.md
Outdated
Comment on lines
19
to
33
| - [Contributing](https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide) | ||
| - [Commit and Release Signing]({{< ref "documentation/guides/signing" >}}) | ||
| - [Licensing]({{< ref "documentation/guides/licensing" >}}) | ||
|
|
||
| ## Release Process | ||
|
|
||
| - [Flow Design System Releases]({{< ref "documentation/guides/fds-releases" >}}) | ||
| - [Maven Plugin Releases]({{< ref "documentation/guides/maven-plugin-releases" >}}) | ||
| - [Releases]({{< ref "documentation/guides/releases" >}}) | ||
|
|
||
| ## Reference Information | ||
|
|
||
| - [Security Reporting]({{< ref "/documentation/security" >}}) | ||
| - [Videos](https://cwiki.apache.org/confluence/display/NIFI/Project+Videos) | ||
| - [Wiki](https://cwiki.apache.org/confluence/display/NIFI/) |
There was a problem hiding this comment.
Same thought here about it being better to mark external links
Comment on lines
14
to
16
| - [Contributing](https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide) | ||
| - [Commit and Release Signing]({{< ref "documentation/guides/signing" >}}) | ||
| - [Developing](https://nifi.apache.org/documentation/nifi-{{< param currentProjectVersion >}}/html/developer-guide.html) |
There was a problem hiding this comment.
External links aren't marked. We should either mark all of them, or remove the indicator the menu. I think adding external icons to all of them is best.
|
Thanks for the feedback @james-elliott. I pushed a commit adding the external link icon to relevant links. With that feedback, I will proceed with merging to the |
exceptionfactory
added a commit
that referenced
this pull request
Dec 22, 2023
- Added Rewrite Rules for historical links - Added linking to Download sections - Removed download links from separate pages - Moved Guides under Documentation directory - Added Version 1 and Version 2 directories under Documentation - Added MiNiFi C++ and Java paragraphs - Moved Videos to Wiki page - Renamed MiNiFi pages associated with Java Agent version This closes #81 Signed-off-by: David Handermann <exceptionfactory@apache.org>
|
Merged to main-staging in commit: 92f976c |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
NIFI-12540 Restructures Documentation and Guides pages to streamline menu navigation.
Signing and Release Guides are moved under a
Guidespage in theDocumentationmenu, instead of appearing directly under theDevelopmentmenu.Additional changes include adding HTTP Rewrite Rules for historical links, removing download links for individual project pages, and adding deep-linking to sections of the main Download page.