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

NIFI-12540 Restructure Documentation and Guides #81

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 10 additions & 32 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -35,57 +35,40 @@ previousProjectVersionReleased = "2023-11-27"

[menu]
[[menu.main]]
name = 'NiFi Documentation 2.0.0-M1'
url = '/documentation'
weight = -1
parent = 'Documentation'
[[menu.main]]
name = 'NiFi Wiki'
name = 'Wiki'
url = 'https://cwiki.apache.org/confluence/display/NIFI'
weight = 10
weight = 3
parent = 'Documentation'
[menu.main.params]
external = true
[[menu.right]]
name = 'Release Notes'
url = 'https://cwiki.apache.org/confluence/display/NIFI/Release+Notes'
weight = -1
parent = 'Downloads'
[menu.right.params]
external = true
[[menu.right]]
name = 'GitHub'
url = 'https://github.com/apache/nifi'
[menu.right.params]
external = true
[[menu.main]]
name = 'Contributor Guide'
name = 'Contributing'
url = 'https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide'
weight = 10
weight = 1
parent = 'Development'
[menu.main.params]
external = true
[[menu.main]]
name = 'People'
name = 'Team'
url = '/community'
weight = 2
weight = 3
parent = 'Community'
[[menu.main]]
name = 'Developer Guide'
url = '/development'
weight = 2
parent = 'Development'
[[menu.main]]
name = 'Issues'
url = 'https://issues.apache.org/jira/browse/NIFI'
weight = 11
weight = 2
parent = 'Development'
[menu.main.params]
external = true
[[menu.main]]
name = 'GitHub Source'
name = 'Source'
url = 'https://github.com/apache/nifi'
weight = 12
weight = 3
parent = 'Development'
[menu.main.params]
external = true
Expand All @@ -102,14 +85,9 @@ previousProjectVersionReleased = "2023-11-27"
[menu.apache.params]
external = true
[[menu.main]]
name = 'MiNiFi Wiki'
name = 'Wiki'
url = 'https://cwiki.apache.org/confluence/display/MiNiFi'
weight = 10
parent = "MiNiFi"
[menu.main.params]
external = true
[[menu.main]]
name = 'Projects Overview'
url = '/projects'
weight = -1
parent = "Projects"
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
---
title: Mailing Lists
title: Contact
menu:
main:
parent: "Community"
name: Mailing Lists
name: Contact
weight: 1
---

# Apache {{< project-label >}} Mailing Lists
# Apache {{< project-label >}} Contact Information

See the [Apache Software Foundation Mailing List Tips](http://apache.org/foundation/mailinglists.html) for
recommendations on how to interact with the community.

## Slack

- [Apache NiFi on Slack](https://apachenifi.slack.com/)
- New users can join the workspace using the [invitation link](https://join.slack.com/t/apachenifi/shared_invite/zt-11njbtkdx-ZRU8FKYSWoEHRJetidy0zA)

## Users Mailing List

List for getting help, asking questions, and reporting problems.
Expand Down Expand Up @@ -49,11 +54,6 @@ List for receiving automated notification of issues or comments from Jira or Git
## Security Mailing List

Private list for reporting potential security issues.
See [Apache NiFi Security Reporting]({{< ref "/documentation/security.html" >}}) for more details.
See [Apache NiFi Security Reporting]({{< ref "/documentation/security" >}}) for more details.

- [Send](mailto:security@nifi.apache.org)

# Apache {{< project-label >}} Chat

- [Apache NiFi on Slack](https://apachenifi.slack.com/)
- New users can join the workspace using the [invitation link](https://join.slack.com/t/apachenifi/shared_invite/zt-11njbtkdx-ZRU8FKYSWoEHRJetidy0zA)
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Powered by NiFi
title: Powered By
menu:
main:
parent: "Community"
name: Powered by NiFi
name: Powered By
weight: 3
---

Expand Down
14 changes: 13 additions & 1 deletion content/development/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" >}})
Copy link
Contributor

Choose a reason for hiding this comment

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

We should mark the external links here with an icon


## Development Resources

- [Issues](https://issues.apache.org/jira/browse/NIFI)
- [Source](https://github.com/apache/nifi)
25 changes: 24 additions & 1 deletion content/documentation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Same thought here about it being better to mark external links

23 changes: 23 additions & 0 deletions content/documentation/guides/_index.md
Original file line number Diff line number Diff line change
@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

- [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" >}})
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: Flow Design System Release Guidelines
menu:
main:
parent: "Development"
name: FDS Release Guide
weight: 5
title: Flow Design System Releases
---

# Apache {{< project-label >}} Flow Design System Release Guidelines
# Apache {{< project-label >}} Flow Design System Releases

The purpose of this document is to capture and describe the steps involved in producing
an official release of Apache NiFi Flow Design System. It is written specifically to someone acting in the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: Licensing Guide
menu:
main:
parent: "Development"
name: Licensing Guide
weight: 6
---

# Apache {{< project-label >}} Release Guidelines
# Apache {{< project-label >}} Licensing

This document provides guidance to contributors of Apache NiFi to help properly account for licensing, notice, and legal requirements.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: NAR Maven Plugin Release Guide
menu:
main:
parent: "Development"
name: NAR Maven Plugin Release Guide
weight: 4
title: NAR Maven Plugin Releases
---

# Apache {{< project-label >}} NAR Maven Plugin Release Guidelines
# Apache {{< project-label >}} NAR Maven Plugin Releases

The purpose of this document is to capture and describe the steps involved in producing
an official release of Apache NiFi NAR Maven Plugin. It is written specifically to someone acting in the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
title: Release Guide
menu:
main:
parent: "Development"
name: Release Guide
weight: 3
title: Releases
---

# Apache {{< project-label >}} Release Guidelines
# Apache {{< project-label >}} Releases

This document describes the steps required to build and release an official version of the project.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
---
title: Commit and Release Signing
menu:
main:
parent: "Development"
name: Commit and Release Signing
weight: 3
---

# Apache {{< project-label >}} Commit and Release Signing
Expand Down
4 changes: 2 additions & 2 deletions content/documentation/security.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Apache NiFi Security Reporting
title: Security Reporting
menu:
main:
name: Security Reporting
parent: "Documentation"
weight: 2
weight: 3
---

# Apache {{< project-label >}} Security
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Documentation"
title: "Documentation for 1.24.0"
layout: "documentation"
iframe: true
menu:
Expand Down
12 changes: 12 additions & 0 deletions content/documentation/v2/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: "Documentation for 2.0.0-M1"
layout: "documentation"
iframe: true
menu:
main:
name: NiFi Documentation 2.0.0-M1
parent: "Documentation"
weight: 1
---

<iframe class="documentation-container" src="https://nifi.apache.org/documentation/nifi-{{< param currentProjectVersion >}}/"></iframe>
39 changes: 0 additions & 39 deletions content/documentation/videos.md

This file was deleted.

23 changes: 18 additions & 5 deletions content/download/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,26 @@ subject to rate limiting.
OpenPGP [Project Keys](https://downloads.apache.org/nifi/KEYS) can be used for
[download verification](https://www.apache.org/info/verification.html).

<ul class="uk-tab" uk-switcher>
<li><a class="uk-active" href="#nifi">NiFi</a></li>
<li><a href="#minifi">MiNiFi</a></li>
<li><a href="#registry">Registry</a></li>
<li><a href="#fds">FDS</a></li>
<ul uk-tab>
<li id="download-nifi"><a href="">NiFi</a></li>
<li id="download-minifi"><a href="">MiNiFi</a></li>
<li id="download-registry"><a href="">Registry</a></li>
<li id="download-fds"><a href="">FDS</a></li>
</ul>

<script type="text/javascript">
window.addEventListener('uikit:init', () => {
var hash = window.location.hash
if (hash) {
var hashDownloadId = hash.replace(/^#/, 'download-');
var downloadElement = document.getElementById(hashDownloadId);
if (downloadElement) {
downloadElement.classList.add('uk-active');
}
}
});
</script>

<ul class="uk-switcher">
<li>

Expand Down