Skip to content

Commit

Permalink
Updated the product name variables (#18312)
Browse files Browse the repository at this point in the history
* Updated the product name variables

* trial variable update

* Add debug message for context, fix Bash nit

* Minor edit on Create Your Cluster node choice and example link

* Fixed nit

* Fix build script

* adding the old variables back for now

* Update src/current/cockroachcloud/create-your-cluster.md

Co-authored-by: Matt Linville (he/him) <linville@cockroachlabs.com>

* Fixed nit

* Update src/current/netlify/build.sh

Co-authored-by: Mike Lewis <76072290+mikeCRL@users.noreply.github.com>

---------

Co-authored-by: Matt Linville <linville@cockroachlabs.com>
Co-authored-by: mikeCRL <mike@cockroachlabs.com>
Co-authored-by: Mike Lewis <76072290+mikeCRL@users.noreply.github.com>
  • Loading branch information
4 people committed Feb 22, 2024
1 parent fdb32a2 commit 1564486
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 19 deletions.
10 changes: 8 additions & 2 deletions src/current/_data/products.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,16 @@ serverless: Serverless

dedicated: Dedicated

core: Self-Hosted

dedicated-advanced: Dedicated advanced

core: Self-Hosted

enterprise: Enterprise

cloud: Cloud

basic: Basic

standard: Standard

advanced: Advanced
2 changes: 1 addition & 1 deletion src/current/cockroachcloud/create-an-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,4 @@ If you are an [Org Administrator]({% link cockroachcloud/authorization.md %}#org

You can change your method of login authentication (email/password or SSO with a specific provider), in the [**My Account** page in the CockroachDB {{ site.data.products.cloud }} Console](https://cockroachlabs.cloud/account/profile).

Once you have changed your authentication method, you will receive a confirmation email."
Once you have changed your authentication method, you will receive a confirmation email.
2 changes: 1 addition & 1 deletion src/current/cockroachcloud/create-your-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Select the region(s) and number of nodes for your cluster:

1. Select the number of nodes:
- For single-region application development and testing, you may create a 1 node cluster.
- For single-region production deployments, we recommend a minimum of 3 nodes. The number of nodes also depends on your storage capacity and performance requirements. See [Example](plan-your-cluster.html?filters=dedicated#dedicated-example) for further guidance.
- For single-region production deployments, Cockroach Labs recommends a minimum of 3 nodes. The number of nodes also relates to your storage capacity and performance requirements. Refer to the [example](plan-your-cluster.html?filters=dedicated#dedicated-example) on [Plan a CockroachDB Cloud cluster](plan-your-cluster.html?filters=dedicated) for further guidance.
- For multi-region deployments, we require a minimum of 3 nodes per region. For best performance and stability, you should use the same number of nodes in each region.
- See [Plan a CockroachDB Cloud cluster](plan-your-cluster.html?filters=dedicated) for the requirements and recommendations for CockroachDB {{ site.data.products.dedicated }} cluster configuration.

Expand Down
9 changes: 3 additions & 6 deletions src/current/cockroachcloud/learn-cockroachdb-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ docs_area: get_started
This tutorial walks you through some of the most important CockroachDB SQL statements. For a list of all supported SQL statements, see [SQL Statements](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/sql-statements).

{{site.data.alerts.callout_info}}
This tutorial is for {{site.data.products.dedicated}} or {{site.data.products.serverless}} users.
This tutorial requires a cluster deployed on {{ site.data.products.cloud }}.
{{site.data.alerts.end}}

## Before you begin

Make sure that you can connect the [`cockroach-sql`](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/cockroach-sql-binary) client to a [{{site.data.products.serverless}}](connect-to-a-serverless-cluster.html?filters=cockroachdb-client) or [{{site.data.products.dedicated}}]({% link cockroachcloud/connect-to-your-cluster.md %}) cluster.
Make sure that you can connect the [`cockroach-sql`](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/cockroach-sql-binary) client to a {{ site.data.products.cloud }} cluster.

## Create a database

Expand Down Expand Up @@ -375,9 +375,6 @@ DROP DATABASE bank;
- [Build a Simple CRUD Python App with CockroachDB and SQLAlchemy](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/build-a-python-app-with-cockroachdb-sqlalchemy)
- [Build a Python App with CockroachDB and Django](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/build-a-python-app-with-cockroachdb-django)
- [Build a Simple CRUD Go App with CockroachDB and the Go pgx Driver](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/build-a-go-app-with-cockroachdb)
- [Connect to a {{site.data.products.serverless}} cluster](connect-to-a-serverless-cluster.html?filters=cockroachdb-client)
- [Connect to a {{site.data.products.dedicated}} cluster]({% link cockroachcloud/connect-to-your-cluster.md %})
- [Serverless FAQs]({% link cockroachcloud/serverless-faqs.md %})
- [Dedicated FAQs]({% link cockroachcloud/frequently-asked-questions.md %})
- [Connect to a {{site.data.products.standard}} cluster]({% link cockroachcloud/connect-to-your-cluster.md %})
- [SQL FAQs](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/drop-database)
- [SQL Statements](https://www.cockroachlabs.com/docs/{{site.current_cloud_version}}/sql-statements)
29 changes: 20 additions & 9 deletions src/current/netlify/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,26 @@
# Populate the site_url to be used by jekyll for generating sidebar and search links
site_url="${DEPLOY_PRIME_URL}"
JEKYLL_ENV="preview"
echo "Netlify has passed context $CONTEXT"
if [[ "$CONTEXT" = "production" ]]; then
site_url="https://www.cockroachlabs.com"
JEKYLL_ENV="production"
fi;
site_url="https://www.cockroachlabs.com"
JEKYLL_ENV="production"
echo "Setting site domain to cockroachlabs.com and JEKYLL_ENV to production"
# For deploy previews and branch deploys, use Netlify-provided domain
# and leave JEKYLL_ENV set to "preview" for more efficient builds
elif [[ "$CONTEXT" = "deploy-preview" ]]; then
echo "Using Netlify-provided deploy preview domain and setting JEKYLL_ENV to preview"
elif [[ "$CONTEXT" = "branch-deploy" ]]; then
echo "Using Netlify-provided branch deploy domain and setting JEKYLL_ENV to preview"
fi

echo "url: ${site_url}" > _config_url.yml

function build {
bundle exec jekyll build --trace --config _config_base.yml,$1
if [[ $? != 0 ]]; then
exit 1
fi;
fi
}

gem install bundler --silent
Expand All @@ -30,7 +38,8 @@ curl -s https://htmltest.wjdp.uk | bash
if [[ $? != 0 ]]; then
echo "Failed to install htmltest"
exit 1
fi;
fi

./bin/build.sh>/dev/null 2>&1

# Run htmltest to check external links on scheduled nightly runs
Expand All @@ -40,20 +49,22 @@ if [[ "$INCOMING_HOOK_TITLE" = "nightly" ]]; then
./bin/htmltest
if [[ $? != 0 ]]; then
exit 1
fi;
fi;
fi
fi

# Run Algolia if building main
if [ "$CONTEXT" == "production" ]; then
echo "Building Algolia index..."
ALGOLIA_API_KEY=${PROD_ALGOLIA_API_KEY} bundle exec jekyll algolia --config _config_base.yml,_config_url.yml --builds-config _config_cockroachdb.yml
fi;
else
echo "Not building Algolia index for context $CONTEXT"
fi

# Run htmltest, but skip checking external links to speed things up
./bin/htmltest --skip-external
if [[ $? != 0 ]]; then
exit 1
fi;
fi

# Run tests defined in __tests__
./node_modules/.bin/jest
Expand Down

0 comments on commit 1564486

Please sign in to comment.