Skip to content

Commit

Permalink
Site updates for DW 6.x
Browse files Browse the repository at this point in the history
  • Loading branch information
keith-ratcliffe committed Jan 25, 2024
1 parent cb389a3 commit 09be397
Show file tree
Hide file tree
Showing 28 changed files with 2,627 additions and 42 deletions.
55 changes: 41 additions & 14 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,34 +63,35 @@ plugins: [jekyll-redirect-from]
#
# For doc updates related to a new major release, you'll need to start with step (1) below.
#
# TODO: create a script to automate the steps below as much as possible, perhaps w/ Grunt
#
# (1) Copy the existing _docs-latest to a new backup folder (aka "collection"), since it's now the "old" version. E.g.,...
# cp -a _docs-latest _docs-3x (Note: maintaining the underscore prefix is important)
#
# (2) Delete the 'redirect' files from the the "old" version, since we prefer to only maintain one set. E.g.,...
# cd _docs-3x/ && rm -f index.md data-model.md quickstart.md tour.md
# cp -a _docs-latest _docs-6x (Note: maintaining the underscore prefix is important)
#
# (2) Delete the 'redirect' files from the "old" version, since we prefer to only maintain one set. E.g.,...
#
# cd _docs-6x/ && rm -f index.md data-model.md quickstart.md tour.md
#
# (3) Update the 'redirect' files in _docs-latest to reflect the new major version as needed. E.g.,...
#
# cd _docs-latest/ && sed -i 's/3.x/5.x/g' *.md
# cd _docs-latest/ && sed -i 's/6.x/7.x/g' *.md
#
# (4) Backup the current _data/sidebars/docs-latest-sidebar.yml to maintain compatibility with the "old" docs version. E.g.,...
#
# cp _data/sidebars/docs-latest-sidebar.yml _data/sidebars/docs-3x-sidebar.yml
# cp _data/sidebars/docs-latest-sidebar.yml _data/sidebars/docs-6x-sidebar.yml
#
# (5) Update _data/sidebars/docs-latest-sidebar.yml to reflect the new major version as needed. E.g.,...
#
# cd _data/sidebars/ && sed -i 's/3.x/5.x/g' docs-latest-sidebar.yml
# cd _data/sidebars/ && sed -i 's/6.x/7.x/g' docs-latest-sidebar.yml
#
# (6) Update _data/topnav.yml to reflect the new version. No need to back this one up since we're only maintaining a
# single top navigation bar for all docs versions, and it should always target the latest docs. E.g.,...
#
# cd _data/ && sed -i 's/3.x/5.x/g' topnav.yml
# cd _data/ && sed -i 's/6.x/7.x/g' topnav.yml
#
# (7) _config.yml: Update the "collections" yaml section below as necessary to preserve permalinks for the new and old versions.
# E.g., copy the "docs-latest" stanza below to a new "docs-3x" stanza, and update the "docs-latest" permalink to reflect
# the new major version
#
# E.g., copy the "docs-latest" stanza below to a new "docs-6x" stanza, and update the "docs-latest" permalink to reflect
# the new 7.x major version
#
# (8) _config.yml: Update Frontmatter "defaults" yaml below as necessary, similar to step #7 above, making sure to
# configure the 'scope:type', 'values:sidebar', and 'values:release_tag' properties for the new and old docs versions
Expand All @@ -106,13 +107,20 @@ collections:
# The "docs-latest" collection renders _docs-latest folder contents to the configured permalink path.
# Note the relationship between this collection and the frontmatter config below where scope:type == 'docs-latest'
docs-latest:
output: true
permalink: "/docs/6.x/:path"

# Likewise, "docs-5x" below renders _docs-5x folder contents, so that users can still navigate to the old docs
# Note the relationship between this collection and the frontmatter config below where scope:type == 'docs-5x'
docs-5x:
# Set 'output: false' to disable rendering of 5.x docs
output: true
permalink: "/docs/5.x/:path"

# Likewise, "docs-3x" below renders _docs-3x folder contents, so that users can still navigate to the old docs
# Note the relationship between this collection and the frontmatter config below where scope:type == 'docs-3x'
docs-3x:
# We could set 'output: false', if we ever decide not to render 3.x docs
# Set 'output: false' to disable rendering of 3.x docs
output: true
permalink: "/docs/3.x/:path"

Expand Down Expand Up @@ -181,21 +189,40 @@ defaults:
skip_title_for_h1: false
toc: true
topnav: topnav
-
# set frontmatter defaults for the previous DW 5.x docs "collection"
scope:
path: ""
type: "docs-5x"
values:
layout: "docs"
title_prefix: "DataWave 5.x Docs - "
# Configure _data/sidebar/docs-5x-sidebar.yml...
sidebar: docs-5x-sidebar
# Note that release_tag is a page-scoped variable that is used for, among
# other things, a means of creating href links to specific source files
# on the main datawave repo, sometimes to specific line #'s in a given source
# file. Thus, changing the release_tag here can potentially break things
release_tag: 5.10.0
show_summary: true
skip_title_for_h1: false
toc: true
topnav: topnav
-
# set frontmatter defaults for the current DW docs version
scope:
path: ""
type: "docs-latest"
values:
layout: "docs"
title_prefix: "DataWave 5.x Docs - "
title_prefix: "DataWave 6.x Docs - "
# Configure _data/sidebar/docs-latest-sidebar.yml...
sidebar: docs-latest-sidebar
# Note that release_tag is a page-scoped variable that is used for, among
# other things, a means of creating href links to specific source files
# on the main datawave repo, sometimes to specific line #'s in a given source
# file. Thus, changing the release_tag here can potentially break things
release_tag: 5.10.0
release_tag: 6.4.5
show_summary: true
skip_title_for_h1: false
toc: true
Expand Down
83 changes: 83 additions & 0 deletions _data/sidebars/docs-5x-sidebar.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# This file is used to construct the sidebar navigation for DataWave 5.x docs

entries:
- title: sidebar
product: DataWave
version: 5.x
folders:

- title: Getting Started
folderitems:

- title: Overview
url: /docs/5.x/getting-started/overview

- title: Data Model
url: /docs/5.x/getting-started/data-model

- title: Development
url: /docs/5.x/getting-started/development

subfolders:
- title: Quickstart
subfolderitems:
- title: Installation
url: /docs/5.x/getting-started/quickstart-install

- title: Reference
url: /docs/5.x/getting-started/quickstart-reference

- title: Troubleshooting
url: /docs/5.x/getting-started/quickstart-trouble

- title: Tour
folderitems:
- title: Getting Started
url: /docs/5.x/tour/getting-started

- title: Ingest Basics
url: /docs/5.x/tour/ingest-basics

- title: Query Basics
url: /docs/5.x/tour/query-basics

- title: Edge Query
url: /docs/5.x/tour/edge-query

- title: Ingest
folderitems:

- title: Overview
url: /docs/5.x/ingest/overview

- title: Data Flow
url: /docs/5.x/ingest/data-flow

- title: Development
url: /docs/5.x/ingest/development

- title: Administration
url: /docs/5.x/ingest/administration

- title: Configuration
url: /docs/5.x/ingest/configuration

- title: Query
folderitems:

- title: Overview
url: /docs/5.x/query/overview

- title: Query Syntax
url: /docs/5.x/query/syntax

- title: Development
url: /docs/5.x/query/development

- title: Administration
url: /docs/5.x/query/administration

- title: Configuration
url: /docs/5.x/query/configuration


44 changes: 22 additions & 22 deletions _data/sidebars/docs-latest-sidebar.yml
Original file line number Diff line number Diff line change
@@ -1,83 +1,83 @@
# This file is used to construct the sidebar navigation for DataWave 5.x docs
# This file is used to construct the sidebar navigation for DataWave 6.x docs

entries:
- title: sidebar
product: DataWave
version: 5.x
version: 6.x
folders:

- title: Getting Started
folderitems:

- title: Overview
url: /docs/5.x/getting-started/overview
url: /docs/6.x/getting-started/overview

- title: Data Model
url: /docs/5.x/getting-started/data-model
url: /docs/6.x/getting-started/data-model

- title: Development
url: /docs/5.x/getting-started/development
url: /docs/6.x/getting-started/development

subfolders:
- title: Quickstart
subfolderitems:
- title: Installation
url: /docs/5.x/getting-started/quickstart-install
url: /docs/6.x/getting-started/quickstart-install

- title: Reference
url: /docs/5.x/getting-started/quickstart-reference
url: /docs/6.x/getting-started/quickstart-reference

- title: Troubleshooting
url: /docs/5.x/getting-started/quickstart-trouble
url: /docs/6.x/getting-started/quickstart-trouble

- title: Tour
folderitems:
- title: Getting Started
url: /docs/5.x/tour/getting-started
url: /docs/6.x/tour/getting-started

- title: Ingest Basics
url: /docs/5.x/tour/ingest-basics
url: /docs/6.x/tour/ingest-basics

- title: Query Basics
url: /docs/5.x/tour/query-basics
url: /docs/6.x/tour/query-basics

- title: Edge Query
url: /docs/5.x/tour/edge-query
url: /docs/6.x/tour/edge-query

- title: Ingest
folderitems:

- title: Overview
url: /docs/5.x/ingest/overview
url: /docs/6.x/ingest/overview

- title: Data Flow
url: /docs/5.x/ingest/data-flow
url: /docs/6.x/ingest/data-flow

- title: Development
url: /docs/5.x/ingest/development
url: /docs/6.x/ingest/development

- title: Administration
url: /docs/5.x/ingest/administration
url: /docs/6.x/ingest/administration

- title: Configuration
url: /docs/5.x/ingest/configuration
url: /docs/6.x/ingest/configuration

- title: Query
folderitems:

- title: Overview
url: /docs/5.x/query/overview
url: /docs/6.x/query/overview

- title: Query Syntax
url: /docs/5.x/query/syntax
url: /docs/6.x/query/syntax

- title: Development
url: /docs/5.x/query/development
url: /docs/6.x/query/development

- title: Administration
url: /docs/5.x/query/administration
url: /docs/6.x/query/administration

- title: Configuration
url: /docs/5.x/query/configuration
url: /docs/6.x/query/configuration


4 changes: 2 additions & 2 deletions _data/topnav.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ topnav:
- title: Topnav
items:
- title: Documentation
url: /docs/5.x/getting-started/overview
url: /docs/6.x/getting-started/overview
- title: Tour
url: /docs/5.x/tour/getting-started
url: /docs/6.x/tour/getting-started
- title: GitHub
external_url: https://github.com/nationalsecurityagency/datawave
- title: News
Expand Down
Loading

0 comments on commit 09be397

Please sign in to comment.