Skip to content

Commit

Permalink
Add local linkcheck and updated exclude list from htmltest. (cockroac…
Browse files Browse the repository at this point in the history
…hdb#14319)

* Add local linkcheck and updated exclude list from htmltest.

* Update netlify build to use wjdp htmltest.

* Removing recent versions from ignore dirs.
  • Loading branch information
Ian Evans authored Jun 21, 2022
1 parent 6332bca commit 4a2795a
Show file tree
Hide file tree
Showing 27 changed files with 43 additions and 29 deletions.
10 changes: 9 additions & 1 deletion .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,24 @@ ExternalTimeout: 30
IgnoreDirs:
- ^docs/stable
- ^docs/dev
- ^docs/v1.0
- ^docs/v1.1
- ^docs/v1.2
- ^docs/v2.0
- ^docs/v2.1
- ^docs/advisories
IgnoreURLs:
- "http://localhost*"
- "http://localhost:*"
- "https://github.com.*"
- "https://movr.cloud"
- "https://support.cockroachlabs.com/*"
- "https://www.php.net/*"
- "https://crates.io/*"
- "https://docs.pipenv.org/*"
- "https://arxiv.org/*"
- "https://fonts.googleapis.com/*"
- "https://fonts.gstatic.com/*"
- "https://typeorm.io/*"
IgnoreInternalEmptyHash: true
TestFilesConcurrently: true
DocumentConcurrencyLimit: 16
7 changes: 6 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,22 @@ no-remote-cache: bootstrap
.PHONY: profile
profile: bootstrap
bundle exec jekyll $(jekyll-action) --incremental --profile --trace --config _config_base.yml,_config_cockroachdb.yml$(extra-config) $(JEKYLLFLAGS)


.PHONY: test
test:
go get -u github.com/cockroachdb/htmltest
# Docker must be running locally for this to work.
./netlify/local
htmltest

.PHONY: linkcheck
linkcheck: cockroachdb-build
htmltest -s

vendor:
gem install bundler
bundle install
go install github.com/wjdp/htmltest@master

bootstrap: Gemfile | vendor
touch $@
Expand Down
8 changes: 4 additions & 4 deletions netlify/build
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ cp _site/docs/404.html _site/404.html

# Set up htmltest

go get -u github.com/cockroachdb/htmltest > /dev/null
pushd $GOPATH/src/github.com/cockroachdb/htmltest && ./build.sh>/dev/null 2>&1 && popd
go get -u github.com/wjdp/htmltest > /dev/null
pushd $GOPATH/src/github.com/wjdp/htmltest && ./build.sh>/dev/null 2>&1 && popd

# Run htmltest to check external links on scheduled nightly runs
# (see .github/workflows/nightly.yml)

if [[ "$INCOMING_HOOK_TITLE" = "nightly" ]]; then
$GOPATH/src/github.com/cockroachdb/htmltest/bin/htmltest
$GOPATH/src/github.com/wjdp/htmltest/bin/htmltest
if [[ $? != 0 ]]; then
exit 1
fi;
Expand All @@ -43,7 +43,7 @@ if [[ "$CONTEXT" = "production" ]]; then
fi;

# Run htmltest, but skip checking external links to speed things up
$GOPATH/src/github.com/cockroachdb/htmltest/bin/htmltest --skip-external
$GOPATH/src/github.com/wjdp/htmltest/bin/htmltest --skip-external

if [[ $? != 0 ]]; then
exit 1
Expand Down
1 change: 1 addition & 0 deletions netlify/vale/CockroachDB/Terminology.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ swap:
Unique constraint: "`UNIQUE` constraint"
Postgres: PostgreSQL
Geo-Partition: geo-partition
multiregion: multi-region
2 changes: 1 addition & 1 deletion v19.1/demo-json-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This page walks you through a simple demonstration of how CockroachDB can store
<div class="filter-content" markdown="1" data-scope="python">
- Install the latest version of [CockroachDB](install-cockroachdb.html).
- Install the [Python psycopg2 driver](http://initd.org/psycopg/docs/install.html): `pip install psycopg2`
- Install the [Python Requests library](http://docs.python-requests.org/en/master/): `pip install requests`
- Install the [Python Requests library](https://requests.readthedocs.io/en/latest/): `pip install requests`
</div>

## Step 2. Start a single-node cluster
Expand Down
2 changes: 1 addition & 1 deletion v19.1/sql-name-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the naming hierarchy, the path to a stored object has three components:
- schema name
- object name

In CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html). A CockroachDB cluster can store multiple databases, and each database can store multiple tables/views/sequences. The list of all databases can be obtained with [`SHOW DATABASES`](show-databases.html).
In CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html). A CockroachDB cluster can store multiple databases, and each database can store multiple tables/views/sequences. The list of all databases can be obtained with [`SHOW DATABASES`](show-databases.html).

In addition to the `public` schema, CockroachDB supports a fixed set of virtual schemas, available in every database, that provide ancillary, non-stored data to client applications. For example, [`information_schema`](information-schema.html) is provided for compatibility with the SQL standard. The list of all schemas for a given database can be obtained with [`SHOW SCHEMAS`](show-schemas.html). The list of all objects for a given schema can be obtained with other `SHOW` statements.

Expand Down
2 changes: 1 addition & 1 deletion v19.2/demo-json-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This page walks you through a simple demonstration of how CockroachDB can store
<div class="filter-content" markdown="1" data-scope="python">
- Install the latest version of [CockroachDB](install-cockroachdb.html).
- Install the [Python psycopg2 driver](http://initd.org/psycopg/docs/install.html): `pip install psycopg2`
- Install the [Python Requests library](http://docs.python-requests.org/en/master/): `pip install requests`
- Install the [Python Requests library](https://requests.readthedocs.io/en/latest/): `pip install requests`
</div>

## Step 2. Start a single-node cluster
Expand Down
2 changes: 1 addition & 1 deletion v19.2/postgresql-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ CockroachDB uses a [lightweight latch](architecture/transaction-layer.html#latch

For compatibility with PostgreSQL, CockroachDB supports a [three-level structure for names](sql-name-resolution.html#naming-hierarchy): databases, schemas, and objects.

However, in CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html).
However, in CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html).

For more details, see [Name Resolution](sql-name-resolution.html).

Expand Down
2 changes: 1 addition & 1 deletion v19.2/sql-name-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the naming hierarchy, the path to a stored object has three components:
- schema name
- object name

In CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html). A CockroachDB cluster can store multiple databases, and each database can store multiple tables/views/sequences. The list of all databases can be obtained with [`SHOW DATABASES`](show-databases.html).
In CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html). A CockroachDB cluster can store multiple databases, and each database can store multiple tables/views/sequences. The list of all databases can be obtained with [`SHOW DATABASES`](show-databases.html).

In addition to the `public` schema, CockroachDB supports a fixed set of virtual schemas, available in every database, that provide ancillary, non-stored data to client applications. For example, [`information_schema`](information-schema.html) is provided for compatibility with the SQL standard. The list of all schemas for a given database can be obtained with [`SHOW SCHEMAS`](show-schemas.html). The list of all objects for a given schema can be obtained with other `SHOW` statements.

Expand Down
2 changes: 1 addition & 1 deletion v2.0/demo-json-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ toc: true
<div class="filter-content" markdown="1" data-scope="python">
- Install the latest version of [CockroachDB](install-cockroachdb.html).
- Install the [Python psycopg2 driver](http://initd.org/psycopg/docs/install.html): `pip install psycopg2`
- Install the [Python Requests library](http://docs.python-requests.org/en/master/): `pip install requests`
- Install the [Python Requests library](https://requests.readthedocs.io/en/latest/): `pip install requests`
</div>

## Step 2. Start a single-node cluster
Expand Down
2 changes: 1 addition & 1 deletion v2.1/demo-json-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This page walks you through a simple demonstration of how CockroachDB can store
<div class="filter-content" markdown="1" data-scope="python">
- Install the latest version of [CockroachDB](install-cockroachdb.html).
- Install the [Python psycopg2 driver](http://initd.org/psycopg/docs/install.html): `pip install psycopg2`
- Install the [Python Requests library](http://docs.python-requests.org/en/master/): `pip install requests`
- Install the [Python Requests library](https://requests.readthedocs.io/en/latest/): `pip install requests`
</div>

## Step 2. Start a single-node cluster
Expand Down
2 changes: 1 addition & 1 deletion v20.1/demo-json-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This page walks you through a simple demonstration of how CockroachDB can store
<div class="filter-content" markdown="1" data-scope="python">
- Install the latest version of [CockroachDB](install-cockroachdb.html).
- Install the [Python psycopg2 driver](http://initd.org/psycopg/docs/install.html): `pip install psycopg2`
- Install the [Python Requests library](http://docs.python-requests.org/en/master/): `pip install requests`
- Install the [Python Requests library](https://requests.readthedocs.io/en/latest/): `pip install requests`
</div>

## Step 2. Start a single-node cluster
Expand Down
2 changes: 1 addition & 1 deletion v20.1/postgresql-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ For more information, see [`SELECT FOR UPDATE`](select-for-update.html).

For compatibility with PostgreSQL, CockroachDB supports a [three-level structure for names](sql-name-resolution.html#naming-hierarchy): databases, schemas, and objects.

However, in CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html).
However, in CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html).

For more details, see [Name Resolution](sql-name-resolution.html).

Expand Down
2 changes: 1 addition & 1 deletion v20.1/sql-name-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the naming hierarchy, the path to a stored object has three components:
- schema name
- object name

In CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html). A CockroachDB cluster can store multiple databases, and each database can store multiple tables/views/sequences. The list of all databases can be obtained with [`SHOW DATABASES`](show-databases.html).
In CockroachDB versions < v20.2, user-defined schemas are not supported, and the only schema available for stored objects is the preloaded `public` schema. As a result, CockroachDB effectively supports a two-level storage structure: databases and objects. To provide a multi-level structure for stored objects, we recommend using database namespaces in the same way as [schema namespaces are used in PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html). A CockroachDB cluster can store multiple databases, and each database can store multiple tables/views/sequences. The list of all databases can be obtained with [`SHOW DATABASES`](show-databases.html).

In addition to the `public` schema, CockroachDB supports a fixed set of virtual schemas, available in every database, that provide ancillary, non-stored data to client applications. For example, [`information_schema`](information-schema.html) is provided for compatibility with the SQL standard. The list of all schemas for a given database can be obtained with [`SHOW SCHEMAS`](show-schemas.html). The list of all objects for a given schema can be obtained with other `SHOW` statements.

Expand Down
2 changes: 1 addition & 1 deletion v20.2/convert-to-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ toc: true

<span class="version-tag">New in v20.2</span>: The `CONVERT TO SCHEMA` [statement](sql-statements.html) converts a database to a new, user-defined [schema](sql-name-resolution.html). When you convert a database to a schema, all [tables](create-table.html), [sequences](create-sequence.html), and [user-defined types](enum.html) in the database become child objects of the new schema, and the database is deleted.

In CockroachDB versions < v20.2, [user-defined schemas](create-schema.html) are not supported, and all stored objects in a given database use the `public` schema. To provide a [multi-level structure for stored objects](sql-name-resolution.html) in earlier versions of CockroachDB, we've recommended using [database](create-database.html) namespaces instead of schema namespaces. The `CONVERT TO SCHEMA` statement is meant to help users who are upgrading to v20.2 and want to use schema namespaces in a way that is more similar to [PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html).
In CockroachDB versions < v20.2, [user-defined schemas](create-schema.html) are not supported, and all stored objects in a given database use the `public` schema. To provide a [multi-level structure for stored objects](sql-name-resolution.html) in earlier versions of CockroachDB, we've recommended using [database](create-database.html) namespaces instead of schema namespaces. The `CONVERT TO SCHEMA` statement is meant to help users who are upgrading to v20.2 and want to use schema namespaces in a way that is more similar to [PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html).

{{site.data.alerts.callout_info}}
`CONVERT TO SCHEMA` is a subcommand of [`ALTER DATABASE`](alter-database.html).
Expand Down
2 changes: 1 addition & 1 deletion v20.2/demo-json-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This page walks you through a simple demonstration of how CockroachDB can store
<div class="filter-content" markdown="1" data-scope="python">
- Install the latest version of [CockroachDB](install-cockroachdb.html).
- Install the [Python psycopg2 driver](http://initd.org/psycopg/docs/install.html): `pip install psycopg2`
- Install the [Python Requests library](http://docs.python-requests.org/en/master/): `pip install requests`
- Install the [Python Requests library](https://requests.readthedocs.io/en/latest/): `pip install requests`
</div>

## Step 2. Start a single-node cluster
Expand Down
2 changes: 1 addition & 1 deletion v20.2/sql-name-resolution.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ To create a new database, use a [`CREATE DATABASE`](create-database.html) statem

In CockroachDB versions < v20.2, [user-defined schemas](create-schema.html) are not supported, and all objects created in a given database use the `public` schema. To provide a multi-level structure for stored objects in earlier versions of CockroachDB, we have recommended using [database](create-database.html) namespaces instead of schema namespaces.

In CockroachDB versions >= v20.2, we recommend using schema namespaces, not database namespaces, to create a naming structure that is more similar to [PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html).
In CockroachDB versions >= v20.2, we recommend using schema namespaces, not database namespaces, to create a naming structure that is more similar to [PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html).

If you are upgrading to v20.2, take any combination of the following actions after the upgrade is complete:

Expand Down
2 changes: 1 addition & 1 deletion v21.1/convert-to-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ toc: true

The `CONVERT TO SCHEMA` [statement](sql-statements.html) converts a database to a new, user-defined [schema](sql-name-resolution.html). When you convert a database to a schema, all [tables](create-table.html), [sequences](create-sequence.html), and [user-defined types](enum.html) in the database become child objects of the new schema, and the database is deleted.

In CockroachDB versions < v20.2, [user-defined schemas](create-schema.html) are not supported, and all stored objects in a given database use the `public` schema. To provide a [multi-level structure for stored objects](sql-name-resolution.html) in earlier versions of CockroachDB, we've recommended using [database](create-database.html) namespaces instead of schema namespaces. The `CONVERT TO SCHEMA` statement is meant to help users who are upgrading to v20.2 and want to use schema namespaces in a way that is more similar to [PostgreSQL](http://www.postgresql.cn/docs/current/ddl-schemas.html).
In CockroachDB versions < v20.2, [user-defined schemas](create-schema.html) are not supported, and all stored objects in a given database use the `public` schema. To provide a [multi-level structure for stored objects](sql-name-resolution.html) in earlier versions of CockroachDB, we've recommended using [database](create-database.html) namespaces instead of schema namespaces. The `CONVERT TO SCHEMA` statement is meant to help users who are upgrading to v20.2 and want to use schema namespaces in a way that is more similar to [PostgreSQL](https://www.postgresql.org/docs/current/ddl-schemas.html).

{{site.data.alerts.callout_info}}
`CONVERT TO SCHEMA` is a subcommand of [`ALTER DATABASE`](alter-database.html).
Expand Down
2 changes: 1 addition & 1 deletion v21.1/demo-json-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This page guides you through a simple demonstration of how CockroachDB can store
<div class="filter-content" markdown="1" data-scope="python">
- Install the latest version of [CockroachDB](install-cockroachdb.html).
- Install the [Python psycopg2 driver](http://initd.org/psycopg/docs/install.html): `pip install psycopg2`
- Install the [Python Requests library](http://docs.python-requests.org/en/master/): `pip install requests`
- Install the [Python Requests library](https://requests.readthedocs.io/en/latest/): `pip install requests`
</div>

## Step 2. Start a single-node cluster
Expand Down
Loading

0 comments on commit 4a2795a

Please sign in to comment.