Skip to content

Commit

Permalink
Stop building training and detailed SQL support pages
Browse files Browse the repository at this point in the history
- Added new top-level /archived directory and adjusted the
  configs to exclude files in that directory from the build.
- Moved the latest versions of training pages to the
  /archived directory for potential future reuse, etc.
  Deleted all other versions.
- Moved the latest version of the details SQL support page
  to the /archived directory. Deleted all other versions.
- Removed any remaining links to the archived pages and made
  cleaned up other site files.

Fixes cockroachdb#7432.
Fixes cockroachdb#4090.
  • Loading branch information
jseldess committed May 28, 2020
1 parent 252a105 commit 5b9170d
Show file tree
Hide file tree
Showing 171 changed files with 32 additions and 23,052 deletions.
11 changes: 5 additions & 6 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Included in this guide:
- [File conventions](#file-conventions)
- [Documentation types](#documentation-types)
- [Reference and task-based docs](#reference-and-task-based-docs)
- [Tutorials, training, and examples](#tutorials-training-and-examples)
- [Tutorials and examples](#tutorials-and-examples)
- [Concept docs](#concept-docs)
- [Components](#components)
- [Headings](#headings)
Expand All @@ -43,7 +43,7 @@ Other general guidance about language and tone:

**Example:** Now that you have a database, user, and a table, run the following code to insert rows into the table.

- For [tutorials, training, and examples](#tutorials-training-and-examples), we recommend you use the second-person point of view (e.g., you). These docs should be more casual and conversational, as if they are teaching the user, but still straightforward and clear.
- For [tutorials and examples](#tutorials-and-examples), we recommend you use the second-person point of view (e.g., you). These docs should be more casual and conversational, as if they are teaching the user, but still straightforward and clear.

**Example:** In this lab, you'll start with a fresh cluster, so make sure you've stopped and cleaned up the cluster from the previous labs.

Expand Down Expand Up @@ -106,14 +106,13 @@ Examples:
- **CLI reference doc example:** [Use the Built-in SQL Client](https://www.cockroachlabs.com/docs/stable/use-the-built-in-sql-client.html)
- **Task-based doc example:** [Orchestrate CockroachDB with Kubernetes](https://www.cockroachlabs.com/docs/stable/orchestrate-cockroachdb-with-kubernetes.html)

### Tutorials, training, and examples
### Tutorials and examples

Tutorials, training, and examples are educational docs or sections meant to acquaint users with CockroachDB and its features. These docs should be written in a more conversational [tone](#language-and-tone), as if they are teaching the user.
Tutorials and examples are educational docs or sections meant to acquaint users with CockroachDB and its features. These docs should be written in a more conversational [tone](#language-and-tone), as if they are teaching the user.

Headings in tutorials and training docs should include `Step N.` to denote the sequence of steps to follow.
Headings in tutorials should include `Step N.` to denote the sequence of steps to follow.

- **Tutorial example:** [JSON Support](https://www.cockroachlabs.com/docs/stable/demo-json-support)
- **Training example:** [Cluster Startup and Scaling](https://www.cockroachlabs.com/docs/stable/training/cluster-startup-and-scaling.html)
- **Example examples:** [Define Table Partitions](https://www.cockroachlabs.com/docs/stable/partitioning.html#examples), [Manage Roles](https://www.cockroachlabs.com/docs/stable/roles.html#example)

### Concept docs
Expand Down
4 changes: 2 additions & 2 deletions _config_base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ exclude:
- "scripts"
- "vendor"
- "jekyll-algolia-dev"
- "hackathon.md"
- "archived"


keep_files: [_internal]

Expand All @@ -83,4 +84,3 @@ algolia:
- index.html
- index.md
- search.html
- "**/training/*.*"
2 changes: 1 addition & 1 deletion _config_cockroachdb_local.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ exclude:
- "ci"
- "scripts"
- "vendor"
- "hackathon.md"
- "archived"
3 changes: 1 addition & 2 deletions _includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,5 +114,4 @@
</div>
</section>

{% if page.sidebar_data != "sidebar-data-training.json" %} {% include
newsletter-popout.html %} {% endif %}
{% include newsletter-popout.html %}
2 changes: 1 addition & 1 deletion _includes/head.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="description" content="{% if page.summary %}{{ page.summary | strip_html | strip_newlines | truncate: 160 }}{% endif %}">
{% endif %}
<meta name="keywords" content="{% if page.tags %}{{ page.tags | join: ', ' | escape }}{% endif %}">
{% if page.block_search or page.url contains 'training' or page.url contains 'v1.0' or page.url contains 'v1.1' or page.url contains 'v2.0' or page.url contains 'v2.1' or page.url contains 'v19.1' %}
{% if page.block_search or page.url contains 'v1.0' or page.url contains 'v1.1' or page.url contains 'v2.0' or page.url contains 'v2.1' or page.url contains 'v19.1' %}
<meta name="robots" content="noindex">
<meta name="robots" content="nofollow">
<meta name="robots" content="noarchive">
Expand Down
15 changes: 2 additions & 13 deletions _includes/sidebar-data-v19.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -661,19 +661,8 @@
},
{
"title": "SQL Feature Support",
"items": [
{
"title": "SQL Support Summary",
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
"title": "Detailed SQL Standard Comparison",
"urls": [
"/${VERSION}/detailed-sql-support.html"
]
}
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
Expand Down
15 changes: 2 additions & 13 deletions _includes/sidebar-data-v19.2.json
Original file line number Diff line number Diff line change
Expand Up @@ -803,19 +803,8 @@
},
{
"title": "SQL Feature Support",
"items": [
{
"title": "SQL Support Summary",
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
"title": "Detailed SQL Standard Comparison",
"urls": [
"/${VERSION}/detailed-sql-support.html"
]
}
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
Expand Down
15 changes: 2 additions & 13 deletions _includes/sidebar-data-v2.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -187,19 +187,8 @@
},
{
"title": "SQL Feature Support",
"items": [
{
"title": "SQL Support Summary",
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
"title": "Detailed SQL Standard Comparison",
"urls": [
"/${VERSION}/detailed-sql-support.html"
]
}
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
Expand Down
21 changes: 2 additions & 19 deletions _includes/sidebar-data-v2.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -552,25 +552,8 @@
},
{
"title": "SQL Feature Support",
"items": [
{
"title": "SQL Support Summary",
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
"title": "Detailed SQL Standard Comparison",
"urls": [
"/${VERSION}/detailed-sql-support.html"
]
},
{
"title": "Postgres DDL Support",
"urls": [
"/${VERSION}/postgres-ddl-support.html"
]
}
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
Expand Down
15 changes: 2 additions & 13 deletions _includes/sidebar-data-v20.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -848,19 +848,8 @@
},
{
"title": "SQL Feature Support",
"items": [
{
"title": "SQL Support Summary",
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
"title": "Detailed SQL Standard Comparison",
"urls": [
"/${VERSION}/detailed-sql-support.html"
]
}
"urls": [
"/${VERSION}/sql-feature-support.html"
]
},
{
Expand Down
3 changes: 3 additions & 0 deletions _redirects
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ build_for: [cockroachdb, cockroachcloud]
/docs/advisories/ /docs/advisories/index.html 200!
/docs/*/contribute-to-cockroachdb.html https://wiki.crdb.io/wiki/spaces/CRDB/pages/73204033/Contributing+to+CockroachDB 301!

# Old training pages redirect to Cockroach University
/docs/*/training/* https://university.cockroachlabs.com 301!

# CockroachCloud page renames
/docs/cockroachcloud/stable/managed-authentication.html /docs/cockroachcloud/stable/cockroachcloud-authentication.html 301!
/docs/cockroachcloud/dev/managed-authentication.html /docs/cockroachcloud/dev/cockroachcloud-authentication.html 301!
Expand Down
3 changes: 3 additions & 0 deletions archived/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Archived Pages

This directory contains pages that we are not building into our docs site but that we want to keep around for potential resurrection.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 0 additions & 1 deletion releases/v19.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ Topic | Description
**Architecture** | Added the [Life of a Distributed Transaction](../v19.1/architecture/life-of-a-distributed-transaction.html), which details the path that a query takes through CockroachDB's architecture, starting with a SQL client and progressing all the way to RocksDB (and then back out again). Also added [Reads and Writes in CockroachDB](../v19.1/architecture/reads-and-writes-overview.html), which explains how reads and writes are affected by the replicated and distributed nature of data in CockroachDB.
**Production Guidance** | Expanded the [Production Checklist](../v19.1/recommended-production-settings.html) with more current hardware recommendations and additional guidance on storage, file systems, and clock synchronization. Also added a library of common [Cluster Topology Patterns](../v19.1/topology-patterns.html).
**ORMs** | Expanded the [SQLAlchemy tutorial](../v19.1/build-a-python-app-with-cockroachdb-sqlalchemy.html) to provide code for transaction retries and best practices for using SQLAlchemy with CockroachDB.
**Training** | Added [geo-partitioning](../v19.1/training/geo-partitioning.html), [Kubernetes](../v19.1/training/orchestration-with-kubernetes.html), and [TPC-C benchmarking](../v19.1/training/performance-benchmarking.html) modules to the intro to CockroachDB training.

## Watch the v19.1 release webinar

Expand Down
1 change: 0 additions & 1 deletion releases/v2.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,6 @@ For information about limitations we've identified in CockroachDB v2.0, with sug

Topic | Description
------|------------
[CockroachDB Training](../v2.1/training/) | This new section of our site introduces you to the fundamentals of CockroachDB, with an emphasis on understanding the architecture and operational basics.
[Production Checklist](../v2.0/recommended-production-settings.html) | This topic now provides cloud-specific hardware, security, load balancing, monitoring and alerting, and clock synchronization recommendations as well as expanded cluster topology guidance. Related [deployment tutorials](../v2.0/manual-deployment.html) have been enhanced with much of this information as well.
[Monitoring and Alerting](../v2.0/monitoring-and-alerting.html) | This new topic explains available tools for monitoring the overall health and performance of a cluster and critical events and metrics to alert on.
[Common Errors](../v2.0/common-errors.html) | This new topic helps you understand and resolve errors you might encounter, including retryable and ambiguous errors for transactions.
Expand Down
1 change: 0 additions & 1 deletion releases/v2.0.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ Get future release notes emailed to you:
- Added a [Performance Tuning tutorial](../v2.0/performance-tuning.html) that demonstrates essential techniques for getting fast reads and writes in CockroachDB, starting with a single-region deployment and expanding into multiple regions. [#3378][#3378]
- Expanded the [Production Checklist](../v2.0/recommended-production-settings.html#networking) to cover a detailed explanation of network flags and scenarios and updated [production deployment tutorials](../v2.0/manual-deployment.html) to encourage the use of `--advertise-host` on node start. [#3352][#3352]
- Expanded the [Kubernetes tutorials](../v2.0/orchestrate-cockroachdb-with-kubernetes.html) to include setting up monitoring and alerting with Prometheus and Alertmanager. [#3370][#3370]
- Published a [full set of training modules on CockroachDB fundamentals](../v2.1/training/), including the architecture and operation, troubleshooting, and maintenance basics. [#3385][#3385]
- Updated the [OpenSSL certificate tutorial](../v2.0/create-security-certificates-openssl.html) to allow multiple node certificates with the same subject. [#3423][#3423]

### Contributors
Expand Down
1 change: 0 additions & 1 deletion releases/v2.1.0-alpha.20180730.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,6 @@ Get future release notes emailed to you:
- Added a tutorial on [benchmarking CockroachDB with TPC-C](../v2.1/performance-benchmarking-with-tpc-c.html). [#3281][#3281]
- Expanded the [Production Checklist](../v2.1/recommended-production-settings.html#networking) to cover a detailed explanation of network flags and scenarios and updated [production deployment tutorials](../v2.1/manual-deployment.html) to encourage the use of `--advertise-host` on node start. [#3352][#3352]
- Expanded the [Kubernetes tutorials](../v2.1/orchestrate-cockroachdb-with-kubernetes.html) to include setting up monitoring and alerting with Prometheus and Alertmanager. [#3370][#3370]
- Published a [full set of training modules on CockroachDB fundamentals](../v2.1/training/), including the architecture and operation, troubleshooting, and maintenance basics. [#3385][#3385]
- Updated the [rolling upgrade tutorial](../v2.1/upgrade-cockroach-version.html) with explicit `systemd` commands. [#3396][#3396]
- Updated the [OpenSSL certificate tutorial](../v2.1/create-security-certificates-openssl.html) to allow multiple node certificates with the same subject. [#3423][#3423]
- Added an example on [editing SQL statements in an external editor from within the built-in SQL shell](../v2.1/use-the-built-in-sql-client.html#edit-sql-statements-in-an-external-editor). [#3425][#3425]
Expand Down
3 changes: 1 addition & 2 deletions releases/v2.1.0-beta.20180910.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,7 @@ Get future release notes emailed to you:

### Doc updates

- Added a [SQL Basics](../v2.1/training/sql-basics.html) training module. [#3710](https://github.com/cockroachdb/docs/pull/3710)
- Updated the [Data Replication](../v2.1/demo-data-replication.html) tutorial, the [Fault Tolerance](../v2.1/training/fault-tolerance-and-automated-repair.html) training, and the [Production Checklist](../v2.1/recommended-production-settings.html) to emphasize the importance of manually increasing the replication factor for important internal data when doing so for the `.default` replication zone. [#3702](https://github.com/cockroachdb/docs/pull/3702)
- Updated the [Data Replication](../v2.1/demo-data-replication.html) tutorial and the [Production Checklist](../v2.1/recommended-production-settings.html) to emphasize the importance of manually increasing the replication factor for important internal data when doing so for the `.default` replication zone. [#3702](https://github.com/cockroachdb/docs/pull/3702)

### Contributors

Expand Down
1 change: 0 additions & 1 deletion releases/v2.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,5 +155,4 @@ Topic | Description
[Performance Tuning](../v2.1/performance-tuning.html) | This new tutorial shows you essential techniques for getting fast reads and writes in CockroachDB, starting with a single-region deployment and expanding into multiple regions.
[Secure "Build an App"](../v2.1/build-an-app-with-cockroachdb.html) | Most client driver and ORM tutorials now provide code samples and guidance for secure clusters.
[Serializable Transactions](../v2.1/demo-serializable.html) | This new tutorial goes through a hypothetical scenario that demonstrates the importance of `SERIALIZABLE` isolation for data correctness.
[SQL Basics Training](../v2.1/training/sql-basics.html) | In this new training, you learn how to use basic SQL statements.
[Window Functions](../v2.1/window-functions.html) | This new page provides information about window function support in CockroachDB.
1 change: 0 additions & 1 deletion releases/v2.1.4.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ $ docker pull cockroachdb/cockroach:v2.1.4
- The new [Life of a Distributed Transaction](../v2.1/architecture/life-of-a-distributed-transaction.html) details the path that a query takes through CockroachDB's architecture, starting with a SQL client and progressing all the way to RocksDB (and then back out again). [#4281](https://github.com/cockroachdb/docs/pull/4281)
- Updated the [Production Checklist](../v2.1/recommended-production-settings.html) with more current hardware recommendations and additional guidance on storage, file systems, and clock synch. [#4153](https://github.com/cockroachdb/docs/pull/4153)
- Expanded the [SQLAlchemy tutorial](../v2.1/build-a-python-app-with-cockroachdb-sqlalchemy.html) to provide code for transaction retries and best practices for using SQLAlchemy with CockroachDB. [#4142](https://github.com/cockroachdb/docs/pull/4142)
- Added [geo-partitioning](../v2.1/training/geo-partitioning.html), [Kubernetes](../v2.1/training/orchestration-with-kubernetes.html), and [TPC-C benchmarking](../v2.1/training/performance-benchmarking.html) modules to the intro to CockroachDB training. [#4214](https://github.com/cockroachdb/docs/pull/4214)

### Contributors

Expand Down
1 change: 0 additions & 1 deletion releases/v2.2.0-alpha.20190114.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,6 @@ Mutation statements like [`UPDATE`](../v19.1/update.html) and [`INSERT`](../v19.

- Updated the [Production Checklist](../v19.1/recommended-production-settings.html) with more current hardware recommendations and additional guidance on storage, file systems, and clock synch. [#4153](https://github.com/cockroachdb/docs/pull/4153)
- Expanded the [SQLAlchemy tutorial](../v19.1/build-a-python-app-with-cockroachdb-sqlalchemy.html) to provide code for transaction retries and best practices for using SQLAlchemy with CockroachDB. [#4142](https://github.com/cockroachdb/docs/pull/4142)
- Added [geo-partitioning](../v19.1/training/geo-partitioning.html), [Kubernetes](../v19.1/training/orchestration-with-kubernetes.html), and [TPC-C benchmarking](../v19.1/training/performance-benchmarking.html) modules to the intro to CockroachDB training. [#4214](https://github.com/cockroachdb/docs/pull/4214)

### Contributors

Expand Down
Loading

0 comments on commit 5b9170d

Please sign in to comment.