You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "exceptionfactory (via GitHub)" <gi...@apache.org> on 2023/12/22 18:01:03 UTC

[PR] NIFI-12540 Restructure Documentation and Guides [nifi-site]

exceptionfactory opened a new pull request, #81:
URL: https://github.com/apache/nifi-site/pull/81

   [NIFI-12540](https://issues.apache.org/jira/browse/NIFI-12540) Restructures Documentation and Guides pages to streamline menu navigation.
   
   Signing and Release Guides are moved under a `Guides` page in the `Documentation` menu, instead of appearing directly under the `Development` menu.
   
   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.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] NIFI-12540 Restructure Documentation and Guides [nifi-site]

Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory closed pull request #81: NIFI-12540 Restructure Documentation and Guides
URL: https://github.com/apache/nifi-site/pull/81


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] NIFI-12540 Restructure Documentation and Guides [nifi-site]

Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on PR #81:
URL: https://github.com/apache/nifi-site/pull/81#issuecomment-1868098176

   Merged to main-staging in commit: https://github.com/apache/nifi-site/commit/92f976c2b4a45c4f18feead10a3323f6d5f954d1


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] NIFI-12540 Restructure Documentation and Guides [nifi-site]

Posted by "exceptionfactory (via GitHub)" <gi...@apache.org>.
exceptionfactory commented on PR #81:
URL: https://github.com/apache/nifi-site/pull/81#issuecomment-1868097403

   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 `main-staging` branch.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] NIFI-12540 Restructure Documentation and Guides [nifi-site]

Posted by "james-elliott (via GitHub)" <gi...@apache.org>.
james-elliott commented on code in PR #81:
URL: https://github.com/apache/nifi-site/pull/81#discussion_r1435321545


##########
content/documentation/_index.md:
##########
@@ -7,4 +7,27 @@ menu:
     weight: 1
 ---
 
-<iframe class="documentation-container" src="https://nifi.apache.org/documentation/nifi-{{< param currentProjectVersion >}}/"></iframe>
+# Apache {{< project-label >}} Documentation
+
+## Configuration and Component Properties
+
+- [NiFi Documentation {{< param currentProjectVersion >}}]({{< ref "/documentation/v2" >}})
+- [NiFi Documentation {{< param previousProjectVersion >}}]({{< ref "/documentation/v1" >}})
+
+## Development Process
+
+- [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/)

Review Comment:
   Same thought here about it being better to mark external links



##########
content/development/_index.md:
##########
@@ -6,4 +6,16 @@ menu:
     weight: 2
 ---
 
-<iframe class="documentation-container" src="http://nifi.apache.org/docs/nifi-docs/html/developer-guide.html"></iframe>
+# Apache {{< project-label >}} Development
+
+## Development Process
+
+- [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" >}})

Review Comment:
   We should mark the external links here with an icon



##########
content/documentation/guides/_index.md:
##########
@@ -0,0 +1,23 @@
+---
+title: Guides
+menu:
+  main:
+    name: Guides
+    parent: "Documentation"
+    weight: 3
+---
+
+# Apache {{< project-label >}} Guides
+
+## Development Process
+
+- [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)

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



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org