diff --git a/docs-chef-io/README.md b/docs-chef-io/README.md index 30cb4441a..761ece8e8 100644 --- a/docs-chef-io/README.md +++ b/docs-chef-io/README.md @@ -75,18 +75,6 @@ You can add shortcodes from other repositories. For example, the `inspec_filter_ {{< /note >}} -### Release Dates - -The chef/chef-web-docs repository uses the `release-dates.json` file in `docs-chef-io/assets/release-notes/inspec-azure` to generate release notes on . See below for more information on release notes for inspec-azure. - -## Update the InSpec Repository Module In `chef/chef-web-docs` - -We use [Hugo modules](https://gohugo.io/hugo-modules/) to build Chef's documentation from multiple repositories. - -When release notes are announced for inspec-azure, the documentation for inspec-azure is updated at the same time. See the section below on release notes. - -A member from the Documentation Team can also update the inspec-azure resource documentation at any time when new resources are ready to be added to . - ## Local Development Environment We use [Hugo](https://gohugo.io/), [Go](https://golang.org/), and[NPM](https://www.npmjs.com/) to build the Chef Documentation website. You will need Hugo 0.93.1 or higher installed and running to build and view our documentation. @@ -117,37 +105,7 @@ Run `make clean_all` to delete the cloned copy of chef/chef-web-docs. ## Publish Release Notes -The process for publishing and announcing release notes for inspec-azure is mostly manual. - -### Edit Pending Release Notes - -Edit the Pending Release Notes file in the [inspec-azure wiki](https://github.com/inspec/inspec-azure/wiki/Pending-Release-Notes). - -We recommend editing this page as new resources are added or changes are made to the inspec-azure resources. - -Have a member of the documentation team review the Pending Release Notes file before they're released. - -### Release the Release Notes - -1. Log in to the chef-cd S3 account using saml2aws. - -2. Run the `publish-release-notes.sh` script in `tools/release-notes`. You can run this from the Makefile with `make publish_release_notes` - - This command pushes the pending release notes to the S3 chef-cd bucket, reset the Pending Release Notes file, and update the `release-dates.json` file in `assets/release-notes/inspec-azure`. - -3. Push up and merge a branch to `inspec/inspec-azure` with the changes made to the `release-dates.json` file. - -### chef-web-docs - -chef-web-docs is configured to open a PR that updates the inspec-azure content on when a change is committed to the `release-dates.json` file in the inspec-azure repository. This updates the InSpec Azure resource documentation and update release notes for InSpec Azure resources. - -A member fo the documentation team can merge that PR for you as soon as it's made. - -### Chef Discourse - -Copy the release notes to a new announcement in [Chef Release Announcements](https://discourse.chef.io/c/chef-release/9) on Discourse. - -You can find the proper release notes in the Pending Release Notes file history or on +InSpec Azure release notes are published from the [chef-web-docs repository](https://github.com/chef/chef-web-docs/). ## Documentation Feedback diff --git a/docs-chef-io/tools/release-notes/publish-release-notes.sh b/docs-chef-io/tools/release-notes/publish-release-notes.sh deleted file mode 100644 index 999bc48eb..000000000 --- a/docs-chef-io/tools/release-notes/publish-release-notes.sh +++ /dev/null @@ -1,48 +0,0 @@ -#!/bin/bash - -set -eou pipefail - -PRODUCT=inspec-azure -CURRENTDATE=$(date +"%Y-%m-%d") -DOCS_ASSETS_DIR="assets/release-notes/inspec-azure" - - -git clone "https://github.com/inspec/inspec-azure.wiki.git" - -# Append the date to the array of dates in assets/release-notes/inspec-azure/release-dates.json -DATES_FILE="${DOCS_ASSETS_DIR}/release-dates.json" -DATES=$( cat "$DATES_FILE" | jq --arg DATE "$CURRENTDATE" '. |= .+ [$DATE]' ) -echo $DATES | jq . > "$DATES_FILE" - -pushd ./inspec-azure.wiki - # Publish release notes to S3 - aws s3 cp Pending-Release-Notes.md "s3://chef-automate-artifacts/release-notes/${PRODUCT}/${CURRENTDATE}.md" --acl public-read --content-type "text/plain" --profile chef-cd - - # Reset "Release Notes" wiki page - cat >./Pending-Release-Notes.md <