From eba6da66ccf2c21cbb1e9e1f9131334d68f32a8e Mon Sep 17 00:00:00 2001 From: Mrugesh Mohapatra Date: Thu, 7 May 2020 16:08:29 +0530 Subject: [PATCH] docs: re-arrange files for management --- docs/{components/cover.md => _coverpage.md} | 0 docs/{components/nav.md => _navbar.md} | 0 docs/{components/sidebar.md => _sidebar.md} | 25 ++++++++++----------- docs/{components/theme.css => _theme.css} | 0 docs/flight-manuals/README.md | 1 + docs/flight-manuals/_sidebar.md | 7 ++++++ docs/index.html | 15 ++++++++----- 7 files changed, 30 insertions(+), 18 deletions(-) rename docs/{components/cover.md => _coverpage.md} (100%) rename docs/{components/nav.md => _navbar.md} (100%) rename docs/{components/sidebar.md => _sidebar.md} (53%) rename docs/{components/theme.css => _theme.css} (100%) create mode 100644 docs/flight-manuals/README.md create mode 100644 docs/flight-manuals/_sidebar.md diff --git a/docs/components/cover.md b/docs/_coverpage.md similarity index 100% rename from docs/components/cover.md rename to docs/_coverpage.md diff --git a/docs/components/nav.md b/docs/_navbar.md similarity index 100% rename from docs/components/nav.md rename to docs/_navbar.md diff --git a/docs/components/sidebar.md b/docs/_sidebar.md similarity index 53% rename from docs/components/sidebar.md rename to docs/_sidebar.md index 1d742cf76c..590a7dd6c9 100644 --- a/docs/components/sidebar.md +++ b/docs/_sidebar.md @@ -1,24 +1,23 @@ - ** Getting Started** - [Introduction](/index.md 'Contribute to the freeCodeCamp.org Community') - ** Code Contribution Guides** - - [How to work on coding challenges](/how-to-work-on-coding-challenges.md) - - [How to help with video challenges](/how-to-help-with-video-challenges.md) - - [How to set up freeCodeCamp locally](/how-to-setup-freecodecamp-locally.md) - - [How to open a pull request](/how-to-open-a-pull-request.md) - - [How to work on the news theme](/how-to-work-on-the-news-theme.md) - - [How to work on the docs theme](/how-to-work-on-the-docs-theme.md) - - [How to catch outgoing emails locally](/how-to-catch-outgoing-emails-locally.md) + - [Work on coding challenges](/how-to-work-on-coding-challenges.md) + - [Help with video challenges](/how-to-help-with-video-challenges.md) + - [Set up freeCodeCamp locally](/how-to-setup-freecodecamp-locally.md) + - [Open a pull request](/how-to-open-a-pull-request.md) + - [Work on the news theme](/how-to-work-on-the-news-theme.md) + - [Work on the docs theme](/how-to-work-on-the-docs-theme.md) + - [Catch outgoing emails locally](/how-to-catch-outgoing-emails-locally.md) - ** Chinese Community Contribution Guides** (中文社区贡献指南) - [Translate news articles (文章翻译计划)](/chinese-guides/news-translations.md) - [Translate videos (视频翻译计划)](/chinese-guides/video-translations.md) -- ** DevOps Guides** - - [How we build, test and deploy](/devops.md) - ** Flight Manuals** (for Staff & Mods) + - [Our DevOps Guide](/devops.md) - [Using Reply Templates](/flight-manuals/using-reply-templates.md) - - [Work on Virtual Machines](/flight-manuals/working-on-virtual-machines.md) - - [Work on API Instances](/flight-manuals/working-on-api-instances.md) - - [Work on Web Server Instances](/flight-manuals/working-on-web-server-instances.md) ----- + - [Other flight manuals](/flight-manuals/) + +--- + - ** Our Community** - [** GitHub Repository**](https://github.com/freecodecamp/freecodecamp) - [** Contributors category on Forum**](https://freecodecamp.org/forum/c/contributors) diff --git a/docs/components/theme.css b/docs/_theme.css similarity index 100% rename from docs/components/theme.css rename to docs/_theme.css diff --git a/docs/flight-manuals/README.md b/docs/flight-manuals/README.md new file mode 100644 index 0000000000..ed58a916e6 --- /dev/null +++ b/docs/flight-manuals/README.md @@ -0,0 +1 @@ +Flight manuals for our staff and mods. \ No newline at end of file diff --git a/docs/flight-manuals/_sidebar.md b/docs/flight-manuals/_sidebar.md new file mode 100644 index 0000000000..f9276bb33f --- /dev/null +++ b/docs/flight-manuals/_sidebar.md @@ -0,0 +1,7 @@ +- [** Go back to previous guides**](/index.md) + +--- + +- [Work on Virtual Machines](/flight-manuals/working-on-virtual-machines.md) +- [Work on API Instances](/flight-manuals/working-on-api-instances.md) +- [Work on Web Server Instances](/flight-manuals/working-on-web-server-instances.md) diff --git a/docs/index.html b/docs/index.html index 437a6013ce..3d89090e08 100644 --- a/docs/index.html +++ b/docs/index.html @@ -13,7 +13,7 @@ + + 'companies including Google, Apple, Amazon, and Microsoft.' name='og:description' /> @@ -28,7 +28,7 @@ - + @@ -45,7 +45,12 @@ window.$docsify = { // Main Config homepage: 'index.md', - loadSidebar: 'components/sidebar.md', + loadSidebar: true, + + // common aliases + alias: { + + }, // break the caching requestHeaders: { @@ -53,7 +58,7 @@ }, // Cover Page - coverpage: 'components/cover.md', + coverpage: true, onlyCover: true, // Navigation @@ -115,4 +120,4 @@ - + \ No newline at end of file