From e7927af8a760c07f351528fd331115fd3e6f6b58 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 13 Mar 2024 15:33:12 +0000 Subject: [PATCH 01/14] Add release version number to navbar Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.toml b/docs/config.toml index 615d5b55e..36d1d0e38 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -87,7 +87,7 @@ version_menu = "Releases" url = "https://edge.docs.radapp.io" [[params.versions]] - version = "latest" + version = "v0.31" url = "https://docs.radapp.io" # Markdown Engine - Allow inline html From 99188fbabb3778b996ac468f1446b3b45bcde789 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 13 Mar 2024 18:31:36 +0000 Subject: [PATCH 02/14] Testing changes to release-docs for version displayed in navbar Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 5 +++++ docs/config.toml | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index 4117c7cf1..3083c208a 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -53,6 +53,11 @@ VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/version = \"edge\"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp mv docs/config.toml.tmp docs/config.toml +# In docs/config.toml, change version to VERSION instead of latest +VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" +awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/version = \"latest\"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp +mv docs/config.toml.tmp docs/config.toml + # In docs/config.toml, change github_branch to CHANNEL_VERSION instead of edge GITHUB_BRANCH_STRING_REPLACEMENT="github_branch = \"${CHANNEL_VERSION}\"" awk -v REPLACEMENT="${GITHUB_BRANCH_STRING_REPLACEMENT}" '{gsub(/github_branch = \"edge\"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp diff --git a/docs/config.toml b/docs/config.toml index 36d1d0e38..615d5b55e 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -87,7 +87,7 @@ version_menu = "Releases" url = "https://edge.docs.radapp.io" [[params.versions]] - version = "v0.31" + version = "latest" url = "https://docs.radapp.io" # Markdown Engine - Allow inline html From bf12cf3dc85580cc42035a7a111d9512aa204401 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 13 Mar 2024 19:16:11 +0000 Subject: [PATCH 03/14] Created a section that strictly replaces `version=latest` Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index 3083c208a..9c786ec2d 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -16,7 +16,7 @@ set -xe -VERSION_NUMBER=$1 # (e.g. 0.1.0) +VERSION_NUMBER='0.33' REPOSITORY="docs" if [[ -z "$VERSION_NUMBER" ]]; then @@ -55,7 +55,7 @@ mv docs/config.toml.tmp docs/config.toml # In docs/config.toml, change version to VERSION instead of latest VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" -awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/version = \"latest\"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp +awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/^[ \t]*version = "latest"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp mv docs/config.toml.tmp docs/config.toml # In docs/config.toml, change github_branch to CHANNEL_VERSION instead of edge From 10904593a6c464adbbf0c91f6ba5f96d8622ac10 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 13 Mar 2024 19:17:16 +0000 Subject: [PATCH 04/14] Fixed a line that shouldnt be changed/ Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index 9c786ec2d..4e1997fbe 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -16,7 +16,7 @@ set -xe -VERSION_NUMBER='0.33' +VERSION_NUMBER=$1 # (e.g. 0.1.0) REPOSITORY="docs" if [[ -z "$VERSION_NUMBER" ]]; then From 635415a11d1e7530fdbe72eb06fb25eec96b1274 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 18 Mar 2024 15:13:53 +0000 Subject: [PATCH 05/14] Made changes to release-docs.sh conditions Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index 4e1997fbe..fe4c40da7 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -55,7 +55,7 @@ mv docs/config.toml.tmp docs/config.toml # In docs/config.toml, change version to VERSION instead of latest VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" -awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/^[ \t]*version = "latest"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp +awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/^[ \t]*version = "(latest|v.*)"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp mv docs/config.toml.tmp docs/config.toml # In docs/config.toml, change github_branch to CHANNEL_VERSION instead of edge From 314687ae985e0dab9bd27551d89efcf6162f5854 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 18 Mar 2024 11:15:27 -0400 Subject: [PATCH 06/14] Update .github/scripts/release-docs.sh Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index fe4c40da7..3ff32869f 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -53,7 +53,7 @@ VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/version = \"edge\"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp mv docs/config.toml.tmp docs/config.toml -# In docs/config.toml, change version to VERSION instead of latest +# In docs/config.toml, change version to VERSION instead of latest or older version VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/^[ \t]*version = "(latest|v.*)"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp mv docs/config.toml.tmp docs/config.toml From 5dfad6d41c6cb1d9be65894c94bdaad201c1e9f2 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Mon, 18 Mar 2024 16:53:05 +0000 Subject: [PATCH 07/14] Addressed feedback Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index 3ff32869f..720aa1523 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -53,9 +53,9 @@ VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/version = \"edge\"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp mv docs/config.toml.tmp docs/config.toml -# In docs/config.toml, change version to VERSION instead of latest or older version -VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" -awk -v REPLACEMENT="${VERSION_STRING_REPLACEMENT}" '{gsub(/^[ \t]*version = "(latest|v.*)"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp +# In docs/config.toml, change version to CHANNEL_VERSION instead of latest or older version +DOC_VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" +awk -v REPLACEMENT="${DOC_VERSION_STRING_REPLACEMENT}" '{gsub(/^[ \t]*version = "(latest|v.*)"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp mv docs/config.toml.tmp docs/config.toml # In docs/config.toml, change github_branch to CHANNEL_VERSION instead of edge From 181ee8d2e8ff1d9599a6fb7b49ef478e1fa10e3b Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 19 Mar 2024 16:15:13 +0000 Subject: [PATCH 08/14] Added config file. Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.toml b/docs/config.toml index 615d5b55e..688f5f20c 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -87,7 +87,7 @@ version_menu = "Releases" url = "https://edge.docs.radapp.io" [[params.versions]] - version = "latest" +version = "v0.31" url = "https://docs.radapp.io" # Markdown Engine - Allow inline html From f44c3f38a8b36fc5678475aa1ad709fcbdbcdb08 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 19 Mar 2024 17:16:37 +0000 Subject: [PATCH 09/14] Fixed indentation Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.toml b/docs/config.toml index 688f5f20c..36d1d0e38 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -87,7 +87,7 @@ version_menu = "Releases" url = "https://edge.docs.radapp.io" [[params.versions]] -version = "v0.31" + version = "v0.31" url = "https://docs.radapp.io" # Markdown Engine - Allow inline html From cf36ee1b67d3a25ef30e530cb26d171eb9488c0d Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 19 Mar 2024 18:55:17 -0400 Subject: [PATCH 10/14] Update docs/config.toml Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.toml b/docs/config.toml index 36d1d0e38..f9d3c894f 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -88,7 +88,7 @@ version_menu = "Releases" [[params.versions]] version = "v0.31" - url = "https://docs.radapp.io" + url = "https://docs.radapp.io" # Markdown Engine - Allow inline html [markup] From 7568729bf5ad87b5f54475f483562bbcaf459105 Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Tue, 19 Mar 2024 18:55:33 -0400 Subject: [PATCH 11/14] Update docs/config.toml Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/config.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.toml b/docs/config.toml index f9d3c894f..36d2b831b 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -87,7 +87,7 @@ version_menu = "Releases" url = "https://edge.docs.radapp.io" [[params.versions]] - version = "v0.31" + version = "v0.31" url = "https://docs.radapp.io" # Markdown Engine - Allow inline html From 02b2efcd3d6e4fcfa943d1342cdda020579b828f Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 20 Mar 2024 17:40:05 +0000 Subject: [PATCH 12/14] Fixed indentation changes that awk made with new command sed Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index 720aa1523..af3eebedd 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -55,8 +55,7 @@ mv docs/config.toml.tmp docs/config.toml # In docs/config.toml, change version to CHANNEL_VERSION instead of latest or older version DOC_VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" -awk -v REPLACEMENT="${DOC_VERSION_STRING_REPLACEMENT}" '{gsub(/^[ \t]*version = "(latest|v.*)"/, REPLACEMENT); print}' docs/config.toml > docs/config.toml.tmp -mv docs/config.toml.tmp docs/config.toml +sed -i.bak -E "s/^( *)[ \t]*version = \"(latest|v.*)\"/\1${DOC_VERSION_STRING_REPLACEMENT}/" docs/config.toml # In docs/config.toml, change github_branch to CHANNEL_VERSION instead of edge GITHUB_BRANCH_STRING_REPLACEMENT="github_branch = \"${CHANNEL_VERSION}\"" From 190e4a6667d2cff1bb7b04f06b1a03e5b176ba5f Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 20 Mar 2024 17:43:25 +0000 Subject: [PATCH 13/14] Added a command for cleanup Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- .github/scripts/release-docs.sh | 2 ++ config.toml | 0 2 files changed, 2 insertions(+) create mode 100644 config.toml diff --git a/.github/scripts/release-docs.sh b/.github/scripts/release-docs.sh index af3eebedd..ef455f099 100755 --- a/.github/scripts/release-docs.sh +++ b/.github/scripts/release-docs.sh @@ -56,6 +56,8 @@ mv docs/config.toml.tmp docs/config.toml # In docs/config.toml, change version to CHANNEL_VERSION instead of latest or older version DOC_VERSION_STRING_REPLACEMENT="version = \"${CHANNEL_VERSION}\"" sed -i.bak -E "s/^( *)[ \t]*version = \"(latest|v.*)\"/\1${DOC_VERSION_STRING_REPLACEMENT}/" docs/config.toml +# Delete the backup file +rm docs/config.toml.bak # In docs/config.toml, change github_branch to CHANNEL_VERSION instead of edge GITHUB_BRANCH_STRING_REPLACEMENT="github_branch = \"${CHANNEL_VERSION}\"" diff --git a/config.toml b/config.toml new file mode 100644 index 000000000..e69de29bb From 6df1436e6d1aa772cd18110d45cad749a6771afd Mon Sep 17 00:00:00 2001 From: jasonviviano <83607984+jasonviviano@users.noreply.github.com> Date: Wed, 20 Mar 2024 13:44:39 -0400 Subject: [PATCH 14/14] Apply suggestions from code review Signed-off-by: jasonviviano <83607984+jasonviviano@users.noreply.github.com> --- docs/config.toml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config.toml b/docs/config.toml index 36d2b831b..36d1d0e38 100644 --- a/docs/config.toml +++ b/docs/config.toml @@ -87,8 +87,8 @@ version_menu = "Releases" url = "https://edge.docs.radapp.io" [[params.versions]] - version = "v0.31" - url = "https://docs.radapp.io" + version = "v0.31" + url = "https://docs.radapp.io" # Markdown Engine - Allow inline html [markup]