This is an automated email from the ASF dual-hosted git repository. exceptionfactory pushed a commit to branch main-staging in repository https://gitbox.apache.org/repos/asf/nifi-site.git
commit dec6c0406f3a2bc90764a77fc8aeeac0e53cfa11 Author: exceptionfactory <[email protected]> AuthorDate: Mon Nov 4 21:24:11 2024 -0600 NIFI-13915 Updated README.md with project links - Updated documentation RewriteRule to latest nifi-docs directory (cherry picked from commit bb9905e781c354a16fe0ad1d35d2d89f760dd315) --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++--------------- static/.htaccess | 2 +- 2 files changed, 53 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 055affb2..33920829 100644 --- a/README.md +++ b/README.md @@ -16,32 +16,66 @@ --> # Apache NiFi Website -The Apache NiFi website uses [Hugo](https://gohugo.io) to build static HTML and related resources. +<img src="https://nifi.apache.org/assets/images/apache-nifi-logo.svg"; width="300" alt="Apache NiFi"/> -## Environment Configuration +### Status -- [Install Hugo](https://gohugo.io/getting-started/installing) -- Clone repository - - `git clone https://github.com/apache/nifi-site.git` +[](https://github.com/apache/nifi-site/actions/workflows/build.yml) +[](https://github.com/apache/nifi-site/blob/main/LICENSE) -## Preview +### Contacts -- Start Hugo Server - - `hugo server` -- Open Browser Preview - - http://localhost:1313/ +[](https://issues.apache.org/jira/browse/NIFI) +[](https://s.apache.org/nifi-community-slack) +[](https://lists.apache.org/[email protected]) +[](https://lists.apache.org/[email protected]) -## Build +### Community -- Run prebuild.sh for generated documentation - - `bash prebuild.sh` +[](https://join.slack.com/t/apachenifi/shared_invite/zt-11njbtkdx-ZRU8FKYSWoEHRJetidy0zA) +[](https://www.linkedin.com/company/apache-nifi/) +[](https://x.com/apachenifi) -- Run Hugo Build - - `hugo` +## Developing -## Publish +The project website uses [Hugo](https://gohugo.io) to build static HTML and related resources. + +### Prerequisites + +- [Hugo](https://gohugo.io/getting-started/installing) + +### Preparation + +Prepare build artifacts using published component manifests for generated documentation. + +```shell +bash prebuild.sh +``` + +### Building + +Start Hugo Server to view rendered pages. + +```shell +hugo server +``` + +Open a web browser to preview rendered pages. + +``` +http://localhost:1313 +``` + +Run Hugo to generate pages in the `public` directory. + +```shell +hugo +``` + +## Publishing The Apache NiFi website uses [GitHub Actions](https://docs.github.com/en/actions) and [Apache Software Foundation Infrastructure](https://infra.apache.org/project-site.html) configuration for automated -publishing. See [Website Publishing](https://cwiki.apache.org/confluence/display/NIFI/Website+Publishing) for -documentation. \ No newline at end of file +publishing. + +See [Website Publishing](https://cwiki.apache.org/confluence/display/NIFI/Website+Publishing) for documentation. diff --git a/static/.htaccess b/static/.htaccess index 6087b77e..73120ad9 100644 --- a/static/.htaccess +++ b/static/.htaccess @@ -5,7 +5,7 @@ RewriteCond %{HTTPS} !=on RewriteRule ^(.*)$ https://%{SERVER_NAME}%{REQUEST_URI} [L,R] # Redirect latest documentation alias to specified version -RewriteRule ^documentation/nifi-latest/html/(.+?)$ /documentation/nifi-2.0.0-M4/html/$1 [L,R] +RewriteRule ^documentation/nifi-latest/html/(.+?)$ /nifi-docs/$1 [L,R] # Redirect component documentation to specified version RewriteRule ^docs/nifi-docs/components/org\.apache\.nifi/([^\/]+?)/[^\/]+?/(.*)$ docs/nifi-docs/components/org.apache.nifi/$1/1.28.0/$2 [L]
![https://nifi.apache.org/assets/images/apache-nifi-logo.svg"](https://nifi.apache.org/assets/images/apache-nifi-logo.svg"){kind=link}
