restore old hidden docs implementation

AhAow353 · Oct 20, 2020 · d818c9f · d818c9f
1 parent 9f10fdd
commit d818c9f
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,8 +4,10 @@
 node_modules
 npm-debug.log
 coverage
+content/early-access
+content/early-access-test
 
 # blc: broken link checker
 blc_output.log
 blc_output_internal.log
-dist
+dist
diff --git a/crowdin.yml b/crowdin.yml
@@ -2,7 +2,8 @@ files:
   - source: /content/**/*.md
     translation: /translations/%locale%/%original_path%/%original_file_name%
     ignore: [
-      "/content/README.md"
+      "/content/README.md",
+      "/content/early-access"
     ]
   - source: /data/**/*.yml
     translation: /translations/%locale%/%original_path%/%original_file_name%
@@ -22,4 +23,4 @@ project_id_env: CROWDIN_PROJECT_ID
 api_token_env: CROWDIN_PERSONAL_TOKEN
 
 # https://support.crowdin.com/configuration-file-v3/#saving-directory-structure-on-server
-preserve_hierarchy: true
+preserve_hierarchy: true
diff --git a/data/ui.yml b/data/ui.yml
@@ -18,6 +18,8 @@ header:
     product_in_progress:
       👋 Hello, explorer! This page is under active development. For the
       most up-to-date and accurate information, please visit our <a href="https://developer.github.com">developer documentation</a>.
+    early_access:
+      👋 This page contains content about an early access feature. Please do not share this URL publicly.
 search:
   need_help: Need help?
   placeholder: Search topics, products...

diff --git a/includes/header.html b/includes/header.html
@@ -15,6 +15,10 @@
   {% elsif currentLanguage == 'en' and site.data.ui.header.notices.flags.product_in_progress == true %}
     {% assign header_notification_type = "product_in_progress" %}
     {% assign header_notification = site.data.ui.header.notices.product_in_progress %}
+
+  {% elsif page.hidden %}
+    {% assign header_notification_type = "early_access" %}
+    {% assign header_notification = site.data.ui.header.notices.early_access %}
   {% endif %}
 
   {% if header_notification %}

diff --git a/lib/algolia/find-indexable-pages.js b/lib/algolia/find-indexable-pages.js
@@ -5,6 +5,8 @@ module.exports = async function findIndexablePages () {
   const indexablePages = allPages
     // exclude pages that are part of WIP products
     .filter(page => !page.parentProduct || !page.parentProduct.wip)
+    // exclude hidden pages
+    .filter(page => !page.hidden)
     // exclude index homepages
     .filter(page => !page.relativePath.endsWith('index.md'))
 

diff --git a/lib/frontmatter.js b/lib/frontmatter.js
@@ -38,11 +38,9 @@ const schema = {
     mapTopic: {
       type: 'boolean'
     },
-    // The `hidden` frontmatter property is no longer used, but leaving it here
-    // with an enum of `[false]` will help us catch any possible regressions.
+    // allow hidden articles under `early-access`
     hidden: {
-      type: 'boolean',
-      enum: [false]
+      type: 'boolean'
     },
     layout: {
       type: ['string', 'boolean'],