Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix site config settings #3

Merged
merged 1 commit into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Examples:

### Images

Add images to `static/images/chef-360/`.
Add images to `static/images/`.

#### Alt text

Expand All @@ -46,7 +46,7 @@ All images must have alt text. See the [W3C WAI guidelines for alt text](https:/
Example:

```md
![alt text](static/images/chef-360/image.png)
![alt text](static/images/image.png)
```

#### Images of text
Expand Down Expand Up @@ -113,14 +113,13 @@ Run `netlify dev` to preview the site using the Netlify CLI.

## Netlify deployment

Netlify deploys content in the `main` branch of this repository to [<https://chef-360.netlify.app>](https://chef-360.netlify.app).
Currently, it's protected with the password `Agentless-artifacts-enable-development-deployments`.
Netlify deploys content in the `main` branch of this repository to [<https://chef-infra-client.netlify.app/>](https://chef-infra-client.netlify.app/).

### Versioning

1. Create a branch of this repo in the following format: `release-<MAJ>.<MIN>`.

1. On the [Netlify site](https://app.netlify.com) add a [branch deploy](https://docs.netlify.com/site-deploys/overview/#set-up-a-branch-deploy-for-specific-branches) for that branch in the chef-360 site configuration.
1. On the [Netlify site](https://app.netlify.com) add a [branch deploy](https://docs.netlify.com/site-deploys/overview/#set-up-a-branch-deploy-for-specific-branches) for that branch in the site configuration.

1. Push the branch up to GitHub. Netlify automatically builds a deployment of that branch at `release-<MAJ>.<MIN>--chef-360.netlify.app/360/<MAJ>.<MIN>`.
1. Push the branch up to GitHub. Netlify automatically builds a deployment of that branch at `release-<MAJ>.<MIN>--chef-infra-client.netlify.app/client/<MAJ>.<MIN>`.
Any changes merged into that branch are automatically deployed.
49 changes: 41 additions & 8 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
## Site-level Parameters
#######

product_name = "Chef Infra Client"

#######
# menuOrder = The order of the menus are included in the left nav menu.
# Menus are defined in the /config/_default/menu.toml file
Expand All @@ -14,11 +16,15 @@ menuOrder = ["landing_page", "licensing", "install", "get_started", "migrate", "
#######

robots = ''

#######
# breadcrumbs = Whether breadcrumbs are enabled.
# See https://gohugo.io/content-management/sections/#ancestors-and-descendants
#
# breadcrumb_base = adds an additional link back to docs.chef.io (or some other link)
#######
breadcrumbs = true

#############
# Parameters specifically for Chef 360 Platform
#############

###
# gh_path = The URL path to the content directory
Expand All @@ -28,17 +34,44 @@ breadcrumbs = true
###

[chef-client]
gh_path = "https://github.com/chef-client-docs/chef-web-docs/blob/main/content/"
gh_path = "https://github.com/chef/chef-client-docs/blob/main/content/"


########
# version_selector = Whether to enable a version selector allowing users to switch between doc versions.
# See "versions" below to define versions used in dropdown menu.
#######
# version_selector = true

### Version dropdown ##########
#
# This section populates the version number dropdown menu.
# Add a table for each version included in the dropdown menu.
#
# 1. Add a table for each version included in the dropdown menu.
# 2. Tables must be in reverse SemVer order.
#
# version = The version number for a release.
# base_url = The base URL for a release. For example, `https://docs.chef.io/chef_360/<MAJ>.<MIN>`
###############################

[[chef-client.versions]]
version = ""
base_url = ""
# [[versions]]
# version = "RC1"
# base_url = "https://docs.chef.io/client/rc1"

#################
#
# Data for this version.
# version = The version this branch documents. `<MAJ>.<MIN>`
# version is required if version_selector = true
# release_date = The release date in ISO 8601 format: `YYYY-MM-DD`.
# github_branch = The repo branch for this version. For example, `release-<MAJ>.<MIN>`.
# deprecated = Whether this version is deprecated. `true` or `false`.
# eol = Whether this version is EOL. `true` or `false`.
#################

# [release_data]
# version = "1.0"
# release_date = "2024-07-02"
# deprecated = false
# eol = false
# github_branch = "release-1.0"
20 changes: 0 additions & 20 deletions config/branch-deploy/params.toml
Original file line number Diff line number Diff line change
@@ -1,23 +1,3 @@
### Version information ##########
#
# Information included in the release that this branch documents.
# This information is used by the index.release-data.json file to generate a release-data.json file.
#
# version = The version this branch documents. `<MAJ>.<MIN>`
# release_date = The release date in ISO 8601 format: `YYYY-MM-DD`.
# github_branch = The repo branch for this version. For example, `release-<MAJ>.<MIN>`.
# deprecated = Whether this version is deprecated. `true` or `false`.
# eol = Whether this version is EOL. `true` or `false`.
##################################

[release_data]
version = ""
release_date = ""
deprecated = false
eol = false
github_branch = ""


breadcrumbs = true

[[breadcrumb_base]]
Expand Down
4 changes: 2 additions & 2 deletions scripts/netlify-branch-deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ set -eoux pipefail

DART_SASS_VERSION="1.72.0"
RELEASE_VERSION=$(echo $HEAD | sed 's/.*-//')
DESTINATION="./public/360/$RELEASE_VERSION"
BASE_URL="https://docs.chef.io/360/$RELEASE_VERSION"
DESTINATION="./public/client/$RELEASE_VERSION"
BASE_URL="https://docs.chef.io/client/$RELEASE_VERSION"

echo Release version: $RELEASE_VERSION
echo Destination: $DESTINATION
Expand Down
Loading