issue-22: Bulk fixing links.

README.md

@@ -13,33 +13,33 @@ S3 filesystem provider for java using the NIO 2 API ([JSR-203]) that just works.
 
 ## Documentation
 
-Please check https://s3fs.carlspring.org
+Please check [https://s3fs-nio.carlspring.org][master-docs-link]
 
 [<--# Links -->]: #
 
 [JSR-203]: https://jcp.org/en/jsr/detail?id=203
 
 [<--# Badges -->]: #
-[master-build-status-link]: https://github.com/carlspring/s3fs-nio2/actions?query=branch%3Amaster
-[master-build-status-badge]: https://github.com/carlspring/s3fs-nio2/workflows/Build%20and%20test%20workflow/badge.svg
+[master-build-status-link]: https://github.com/carlspring/s3fs-nio/actions?query=branch%3Amaster
+[master-build-status-badge]: https://github.com/carlspring/s3fs-nio/workflows/Build%20and%20test%20workflow/badge.svg
 
-[master-docs-link]: https://carlspring.github.io/s3fs-nio2
+[master-docs-link]: https://s3fs-nio.carlspring.org
 [master-docs-badge]: https://img.shields.io/badge/docs-current-brightgreen.svg
 
 [license-link]: https://opensource.org/licenses/Apache-2.0
 [license-badge]: https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg
 
-[codetriage-link]: https://www.codetriage.com/carlspring/s3fs-nio2
-[codetriage-badge]: https://www.codetriage.com/carlspring/s3fs-nio2/badges/users.svg
+[codetriage-link]: https://www.codetriage.com/carlspring/s3fs-nio
+[codetriage-badge]: https://www.codetriage.com/carlspring/s3fs-nio/badges/users.svg
 
-[good-first-issue-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good%20first%20issue%22
-[good-first-issue-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/good%20first%20issue.svg?label=good%20first%20issue
+[good-first-issue-link]: https://github.com/carlspring/s3fs-nio/issues?q=is%3Aissue+is%3Aopen+label%3A%22good%20first%20issue%22
+[good-first-issue-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/good%20first%20issue.svg?label=good%20first%20issue
 
-[help-wanted-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22
-[help-wanted-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/help%20wanted.svg?label=help%20wanted&color=%23856bf9& 
+[help-wanted-link]: https://github.com/carlspring/s3fs-nio/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22
+[help-wanted-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/help%20wanted.svg?label=help%20wanted&color=%23856bf9& 
 
-[hacktoberfest-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22hacktoberfest%22
-[hacktoberfest-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/hacktoberfest.svg?label=hacktoberfest&color=orange
+[hacktoberfest-link]: https://github.com/carlspring/s3fs-nio/issues?q=is%3Aissue+is%3Aopen+label%3A%22hacktoberfest%22
+[hacktoberfest-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/hacktoberfest.svg?label=hacktoberfest&color=orange
 
-[stackoverflow-link]: https://stackoverflow.com/tags/s3fs-nio2/
+[stackoverflow-link]: https://stackoverflow.com/tags/s3fs-nio/
 [stackoverflow-badge]: https://img.shields.io/badge/stackoverflow-ask-orange.svg

docs/content/chat.md

@@ -1 +1 @@
-redirect: https://chat.carlspring.org/channel/s3fs-nio-community
+redirect: {{ chat_url }}

docs/content/contributing/developer-guide/index.md

@@ -59,9 +59,9 @@ TODO: Add a guide to run tests with MinIO and docker-compose
 [<--# Links -->]: #
 [Maven 3.6+]: https://maven.apache.org/download.cgi
 [issue-tracker]: {{ repo_url }}/issues
-[good-first-issue-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good%20first%20issue%22
-[good-first-issue-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/good%20first%20issue.svg?label=good%20first%20issue
-[help-wanted-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22
-[help-wanted-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/help%20wanted.svg?label=help%20wanted&color=%23856bf9& 
-[hacktoberfest-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22hacktoberfest%22
-[hacktoberfest-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/hacktoberfest.svg?label=hacktoberfest&color=orange
+[good-first-issue-link]: {{ repo_url }}/issues?q=is%3Aissue+is%3Aopen+label%3A%22good%20first%20issue%22
+[good-first-issue-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/good%20first%20issue.svg?label=good%20first%20issue
+[help-wanted-link]: {{ repo_url }}/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22
+[help-wanted-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/help%20wanted.svg?label=help%20wanted&color=%23856bf9& 
+[hacktoberfest-link]: {{ repo_url }}/issues?q=is%3Aissue+is%3Aopen+label%3A%22hacktoberfest%22
+[hacktoberfest-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/hacktoberfest.svg?label=hacktoberfest&color=orange

docs/content/history.md

@@ -34,4 +34,4 @@ If you want help us out you can check our [Contributing] section for more detail
 
 
 [<--# Links -->]: #
-[Contributing]: /contributing/index.md "Contributing page"
+[Contributing]: ./contributing/index.md "Contributing page"

docs/content/index.md

@@ -1,4 +1,4 @@
-# S3FS NIO2
+# {{ site_name }}
 
 S3 filesystem provider for java using the NIO 2 API ([JSR-203]) that just works.
 
@@ -61,7 +61,7 @@ S3 filesystem provider for java using the NIO 2 API ([JSR-203]) that just works.
     These properties can also be exported as environment variables.
     A complete list is available in the [Configuration Reference]
 
-=== "2. Example"
+=== "2. Code"
 
     ```java
     --8<-- "../src/test/java/org/carlspring/cloud/storage/s3fs/ExampleClass.java"
@@ -84,31 +84,31 @@ S3 filesystem provider for java using the NIO 2 API ([JSR-203]) that just works.
 [JSR-203]: https://jcp.org/en/jsr/detail?id=203 "JSR-203"
 [Contributing]: ./contributing/index.md "Contributing"
 [Configuration Reference]: ./reference/configuration.md "Configuration Reference"
-[More examples]: ./examples "More examples"
+[More examples]: ./reference/examples.md "More examples"
 [S3 Console]: https://s3.console.aws.amazon.com/s3/home "Amazon S3 Console"
 [IAM]: https://console.aws.amazon.com/iam/home "Amazon IAM"
 
 [<--# Badges -->]: #
-[master-build-status-link]: https://github.com/carlspring/s3fs-nio2/actions?query=branch%3Amaster
-[master-build-status-badge]: https://github.com/carlspring/s3fs-nio2/workflows/Build%20and%20test%20workflow/badge.svg
+[master-build-status-link]: {{ repo_url }}/actions?query=branch%3Amaster
+[master-build-status-badge]: {{ repo_url }}/workflows/Build%20and%20test%20workflow/badge.svg
 
-[master-docs-link]: https://carlspring.github.io/s3fs-nio2
+[master-docs-link]: {{ docs_url }}
 [master-docs-badge]: https://img.shields.io/badge/docs-current-brightgreen.svg
 
 [license-link]: https://opensource.org/licenses/Apache-2.0
 [license-badge]: https://img.shields.io/badge/License-Apache%202.0-brightgreen.svg
 
-[codetriage-link]: https://www.codetriage.com/carlspring/s3fs-nio2
-[codetriage-badge]: https://www.codetriage.com/carlspring/s3fs-nio2/badges/users.svg
+[codetriage-link]: https://www.codetriage.com/carlspring/s3fs-nio
+[codetriage-badge]: https://www.codetriage.com/carlspring/s3fs-nio/badges/users.svg
 
-[good-first-issue-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22good%20first%20issue%22
-[good-first-issue-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/good%20first%20issue.svg?label=good%20first%20issue
+[good-first-issue-link]: {{ repo_url }}/issues?q=is%3Aissue+is%3Aopen+label%3A%22good%20first%20issue%22
+[good-first-issue-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/good%20first%20issue.svg?label=good%20first%20issue
 
-[help-wanted-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22
-[help-wanted-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/help%20wanted.svg?label=help%20wanted&color=%23856bf9& 
+[help-wanted-link]: {{ repo_url }}/issues?q=is%3Aissue+is%3Aopen+label%3A%22help%20wanted%22
+[help-wanted-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/help%20wanted.svg?label=help%20wanted&color=%23856bf9& 
 
-[hacktoberfest-link]: https://github.com/carlspring/s3fs-nio2/issues?q=is%3Aissue+is%3Aopen+label%3A%22hacktoberfest%22
-[hacktoberfest-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio2/hacktoberfest.svg?label=hacktoberfest&color=orange
+[hacktoberfest-link]: {{ repo_url }}/issues?q=is%3Aissue+is%3Aopen+label%3A%22hacktoberfest%22
+[hacktoberfest-badge]: https://img.shields.io/github/issues-raw/carlspring/s3fs-nio/hacktoberfest.svg?label=hacktoberfest&color=orange
 
-[stackoverflow-link]: https://stackoverflow.com/tags/s3fs-nio2/
+[stackoverflow-link]: https://stackoverflow.com/tags/s3fs-nio/
 [stackoverflow-badge]: https://img.shields.io/badge/stackoverflow-ask-orange.svg

docs/content/license.md

@@ -6,14 +6,14 @@ This project would not have been possible without the initial implementation(s)
  * @Upplication/Amazon-S3-FileSystem-NIO2 (fork with fixes, mainly `Apache 2.0`, but some `MIT` as well)
  * Other forks (only ones licensed under `Apache 2.0` or `MIT`)
 
-We deeply value and respect the work of all involved developers, which is why @carlspring/s3fs-nio2 has been `dual-licensed`:
+We deeply value and respect the work of all involved developers, which is why @carlspring/s3fs-nio has been `dual-licensed`:
 
 1. All existing code will continue to be licensed under the respectful initial license - either `MIT` or `Apache 2.0`
 2. For consistency reasons - all future code **will be** licensed under `Apache 2.0`
 
 ## Apache 2.0
 
-The latest version can be found in the [LICENSE.Apache-2.0.md] file in the @carlspring/s3fs-nio2 repository.
+The latest version can be found in the [LICENSE.Apache-2.0.md] file in the @carlspring/s3fs-nio repository.
 
 
 !!! success "This license header must be present in all future contributions"
@@ -24,8 +24,8 @@ The latest version can be found in the [LICENSE.Apache-2.0.md] file in the @carl
 
 ## MIT
 
-The latest version can be found in the [LICENSE.MIT.md] file in the @carlspring/s3fs-nio2 repository.
+The latest version can be found in the [LICENSE.MIT.md] file in the @carlspring/s3fs-nio repository.
 
 [<--# Links -->]: #
-[LICENSE.Apache-2.0.md]: https://github.com/carlspring/s3fs-nio2/blob/master/LICENSE.Apache-2.0.md
-[LICENSE.MIT.md]: https://github.com/carlspring/s3fs-nio2/blob/master/LICENSE.MIT.md
+[LICENSE.Apache-2.0.md]: {{ repo_url }}/blob/master/LICENSE.Apache-2.0.md
+[LICENSE.MIT.md]: {{ repo_url }}/blob/master/LICENSE.MIT.md

docs/content/versioning.md

@@ -9,7 +9,7 @@ stable release.
 
 ## Versioning policy
 
-S3FS NIO2 is following the [semantic versioning][semver] guide to ensure we introduce predictable changes.
+{{ project_name }} is following the [semantic versioning][semver] guide to ensure we introduce predictable changes.
 
 * Release version numbers have three parts: `major.minor.patch`.  
   For example, version `1.2.3` indicates major version 1, minor version 2, and patch level 3.

docs/docker-compose.yml

@@ -5,7 +5,7 @@ services:
       context: .
       dockerfile: ./docs.Dockerfile
     image: squidfunk/mkdocs-material:5.5.9-custom
-    container_name: s3fs-nio2-docs
+    container_name: s3fs-nio-docs
     working_dir: /workspace/docs
     volumes:
       - ../:/workspace

docs/mkdocs.yml

@@ -68,7 +68,7 @@ markdown_extensions:
   - pymdownx.magiclink:
       repo_url_shorthand: true
       user: carlspring
-      repo: s3fs-nio2
+      repo: s3fs-nio
   - pymdownx.mark
   - pymdownx.smartsymbols
   - pymdownx.snippets:
@@ -89,8 +89,11 @@ extra:
   resourcesPath: &resourcesPath !!python/object/apply:urllib.parse.urljoin [*assetsPath, "resources"]
   assets: !!python/object/apply:urllib.parse.urljoin [*url, *assetsPath]
   resources: !!python/object/apply:urllib.parse.urljoin [*url, *resourcesPath]
+  site_name: &site_name S3FS NIO
+  project_name: *site_name
   repo_url: &repo_url https://github.com/carlspring/s3fs-nio
   chat_url: &chat_url https://chat.carlspring.org/channel/s3fs-nio-community
+  docs_url: https://s3fs-nio.carlspring.org
   social:
   - icon: fontawesome/brands/github-alt
     link: *repo_url