From ebc812c4ede094195ebe369e58bce3cb6604d09b Mon Sep 17 00:00:00 2001 From: karthik-us Date: Fri, 1 Mar 2024 19:44:15 +0530 Subject: [PATCH] doc: fix broken links This patch fixes the broken links in the non rendered documents on github and keeps the structre of the rendered documents on the website intact as well. Signed-off-by: karthik-us --- Documentation/.pages | 12 ++++++++++++ Documentation/Getting-Started/.pages | 2 +- Documentation/Getting-Started/intro.md | 1 - Documentation/README.md | 4 ++-- Documentation/intro.md | 1 + mkdocs.yml | 2 +- 6 files changed, 17 insertions(+), 5 deletions(-) delete mode 120000 Documentation/Getting-Started/intro.md create mode 120000 Documentation/intro.md diff --git a/Documentation/.pages b/Documentation/.pages index c6dc6332d..078a20589 100644 --- a/Documentation/.pages +++ b/Documentation/.pages @@ -6,3 +6,15 @@ nav: - Troubleshooting - Upgrade - Contributing + - Getting Started: + - Rook: intro.md + - Glossary: Getting-Started/glossary + - Prerequisites: + - Prerequisites: Getting-Started/Prerequisites/prerequisites.md + - Authenticated Container Registries: Getting-Started/Prerequisites/authenticated-registry + - Quick Start: Getting-Started/quickstart + - Storage Architecture: Getting-Started/storage-architecture + - Example Configurations: Getting-Started/example-configurations + - OpenShift: Getting-Started/ceph-openshift + - Cleanup: Getting-Started/ceph-teardown + - Release: Getting-Started/release-cycle diff --git a/Documentation/Getting-Started/.pages b/Documentation/Getting-Started/.pages index 165242426..29bb29b3d 100644 --- a/Documentation/Getting-Started/.pages +++ b/Documentation/Getting-Started/.pages @@ -1,5 +1,5 @@ nav: - - intro.md + - Rook: ../intro - glossary.md - Prerequisites - quickstart.md diff --git a/Documentation/Getting-Started/intro.md b/Documentation/Getting-Started/intro.md deleted file mode 120000 index 32d46ee88..000000000 --- a/Documentation/Getting-Started/intro.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/Documentation/README.md b/Documentation/README.md index ede5c8523..986a87b1b 100644 --- a/Documentation/README.md +++ b/Documentation/README.md @@ -18,11 +18,11 @@ Rook is hosted by the [Cloud Native Computing Foundation](https://cncf.io) (CNCF ## Quick Start Guide Starting Ceph in your cluster is as simple as a few `kubectl` commands. -See our [Quickstart](quickstart.md) guide to get started with the Ceph operator! +See our [Quickstart](Getting-Started/quickstart.md) guide to get started with the Ceph operator! ## Designs -[Ceph](https://docs.ceph.com/en/latest/) is a highly scalable distributed storage solution for block storage, object storage, and shared filesystems with years of production deployments. See the [Ceph overview](storage-architecture.md). +[Ceph](https://docs.ceph.com/en/latest/) is a highly scalable distributed storage solution for block storage, object storage, and shared filesystems with years of production deployments. See the [Ceph overview](Getting-Started/storage-architecture.md). For detailed design documentation, see also the [design docs](https://github.com/rook/rook/tree/master/design). diff --git a/Documentation/intro.md b/Documentation/intro.md new file mode 120000 index 000000000..42061c01a --- /dev/null +++ b/Documentation/intro.md @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 6b7b20db6..b0588903e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,7 +72,7 @@ plugins: #js_files: [] - redirects: redirect_maps: - README.md: Getting-Started/intro.md + README.md: intro.md - mike: # these fields are all optional; the defaults are as below... version_selector: true # set to false to leave out the version selector