From 09bc13498badfbef2f6bfc0c4c5adad40e861620 Mon Sep 17 00:00:00 2001 From: Oreoluwa Agunbiade Date: Thu, 25 May 2023 16:16:27 -0600 Subject: [PATCH 1/3] Add knowledge-base sidebar link to Pipelines and Refarch --- .../developer-portal/create-account.md | 2 +- _docs-sources/developer-portal/invite-team.md | 2 +- .../developer-portal/link-github-id.md | 4 +- docs/developer-portal/create-account.md | 4 +- docs/developer-portal/invite-team.md | 4 +- docs/developer-portal/link-github-id.md | 6 +- sidebars/developer-portal.js | 6 +- sidebars/pipelines.js | 98 ++++++++++--------- sidebars/refarch.js | 10 ++ 9 files changed, 78 insertions(+), 58 deletions(-) diff --git a/_docs-sources/developer-portal/create-account.md b/_docs-sources/developer-portal/create-account.md index 45a3158956..61aab83c05 100644 --- a/_docs-sources/developer-portal/create-account.md +++ b/_docs-sources/developer-portal/create-account.md @@ -31,7 +31,7 @@ For security, sign in emails expire after 10 minutes. You can enter your email a If you are the admin for your organization, you'll be prompted to confirm details including your company address and phone number, as well as a billing email. Provide the required information and click **Continue** to finish signing in. -## Related FAQs +## Related Knowledge Base Discussions - [Invitation to the Developer Portal not received](https://github.com/orgs/gruntwork-io/discussions/716) - [Trouble logging into the Portal with email](https://github.com/orgs/gruntwork-io/discussions/395) diff --git a/_docs-sources/developer-portal/invite-team.md b/_docs-sources/developer-portal/invite-team.md index 105657c011..056a74aa05 100644 --- a/_docs-sources/developer-portal/invite-team.md +++ b/_docs-sources/developer-portal/invite-team.md @@ -40,7 +40,7 @@ This change will take effect immediately. Any team members who have accepted the The number of licenses available depends on the level of your subscription. You can see the total number of licenses as well as the number remaining at the top of the [Team](https://app.gruntwork.io/team) page. If you need to invite more team members than your current license limit allows, you may request additional licenses, which are billed at a standard monthly rate. To do so, contact sales@gruntwork.io. -## Related FAQs +## Related Knowledge Base Discussions - [Invitation to the Developer Portal not received](https://github.com/orgs/gruntwork-io/discussions/716) - [Trouble logging into the Portal with email](https://github.com/orgs/gruntwork-io/discussions/395) diff --git a/_docs-sources/developer-portal/link-github-id.md b/_docs-sources/developer-portal/link-github-id.md index 9d16d96912..e4cbd124df 100644 --- a/_docs-sources/developer-portal/link-github-id.md +++ b/_docs-sources/developer-portal/link-github-id.md @@ -14,7 +14,7 @@ Once you’ve linked your account, the notice on the home page will disappear an ::: -## Related FAQs +## Related Knowledge Base Discussions - [I have linked my GitHub Account but do not have code access](https://github.com/orgs/gruntwork-io/discussions/715) -- [How can I change my GitHub account(unlink/link)?](https://github.com/orgs/gruntwork-io/discussions/713) +- [How can I change my GitHub account (unlink/link)?](https://github.com/orgs/gruntwork-io/discussions/713) diff --git a/docs/developer-portal/create-account.md b/docs/developer-portal/create-account.md index 5f376bd69d..265466711e 100644 --- a/docs/developer-portal/create-account.md +++ b/docs/developer-portal/create-account.md @@ -31,7 +31,7 @@ For security, sign in emails expire after 10 minutes. You can enter your email a If you are the admin for your organization, you'll be prompted to confirm details including your company address and phone number, as well as a billing email. Provide the required information and click **Continue** to finish signing in. -## Related FAQs +## Related Knowledge Base Discussions - [Invitation to the Developer Portal not received](https://github.com/orgs/gruntwork-io/discussions/716) - [Trouble logging into the Portal with email](https://github.com/orgs/gruntwork-io/discussions/395) @@ -41,6 +41,6 @@ If you are the admin for your organization, you'll be prompted to confirm detail diff --git a/docs/developer-portal/invite-team.md b/docs/developer-portal/invite-team.md index 9c9a40f7e5..62d4f770c2 100644 --- a/docs/developer-portal/invite-team.md +++ b/docs/developer-portal/invite-team.md @@ -40,7 +40,7 @@ This change will take effect immediately. Any team members who have accepted the The number of licenses available depends on the level of your subscription. You can see the total number of licenses as well as the number remaining at the top of the [Team](https://app.gruntwork.io/team) page. If you need to invite more team members than your current license limit allows, you may request additional licenses, which are billed at a standard monthly rate. To do so, contact sales@gruntwork.io. -## Related FAQs +## Related Knowledge Base Discussions - [Invitation to the Developer Portal not received](https://github.com/orgs/gruntwork-io/discussions/716) - [Trouble logging into the Portal with email](https://github.com/orgs/gruntwork-io/discussions/395) @@ -50,6 +50,6 @@ The number of licenses available depends on the level of your subscription. You diff --git a/docs/developer-portal/link-github-id.md b/docs/developer-portal/link-github-id.md index ce58e7d484..19dd783c77 100644 --- a/docs/developer-portal/link-github-id.md +++ b/docs/developer-portal/link-github-id.md @@ -14,15 +14,15 @@ Once you’ve linked your account, the notice on the home page will disappear an ::: -## Related FAQs +## Related Knowledge Base Discussions - [I have linked my GitHub Account but do not have code access](https://github.com/orgs/gruntwork-io/discussions/715) -- [How can I change my GitHub account(unlink/link)?](https://github.com/orgs/gruntwork-io/discussions/713) +- [How can I change my GitHub account (unlink/link)?](https://github.com/orgs/gruntwork-io/discussions/713) diff --git a/sidebars/developer-portal.js b/sidebars/developer-portal.js index d57d683f71..8560fef675 100644 --- a/sidebars/developer-portal.js +++ b/sidebars/developer-portal.js @@ -1,4 +1,4 @@ -const developerPortalKnowledgeBaseDiscussions = +const kbLink = "https://github.com/orgs/gruntwork-io/discussions?discussions_q=" + // filter by discussions with the label "s:dev-portal" & sort by top voted discussions first encodeURIComponent("label:s:dev-portal sort:top") @@ -14,8 +14,8 @@ const sidebar = [ "developer-portal/link-github-id", { type: "link", - label: "FAQ", - href: developerPortalKnowledgeBaseDiscussions, + label: "Knowledge Base", + href: kbLink, }, ], }, diff --git a/sidebars/pipelines.js b/sidebars/pipelines.js index 200e419c08..d2653962d8 100644 --- a/sidebars/pipelines.js +++ b/sidebars/pipelines.js @@ -1,51 +1,61 @@ +const kbLink = + "https://github.com/orgs/gruntwork-io/discussions?discussions_q=" + + // filter by discussions with the label s:CI/Pipelines & sort by top voted discussions first + encodeURIComponent("label:s:CI/Pipelines sort:top") + const sidebar = [ - { - label: "Gruntwork Pipelines", + { + label: "Gruntwork Pipelines", + type: "category", + collapsible: false, + items: [ + { + label: "Overview", + type: "category", + collapsible: false, + items: [ + { + label: "What is Gruntwork Pipelines?", + type: "doc", + id: "pipelines/overview/index", + }, + ], + }, + { + label: "Getting Started", type: "category", collapsible: false, items: [ - { - label: "Overview", - type: "category", - collapsible: false, - items: [ - { - label: "What is Gruntwork Pipelines?", - type: "doc", - id: "pipelines/overview/index" - }, - ] - }, - { - label: "Getting Started", - type: "category", - collapsible: false, - items: [ - { - label: "How it works", - type: "doc", - id: "pipelines/how-it-works/index", - }, - { - label: "Single Account Tutorial", - type: "doc", - id: "pipelines/tutorial/index", - }, - // { - // label: "Deploying Multi-Account Pipelines", - // type: "doc", - // id: "pipelines/multi-account/index", - // }, - ] - }, - { - label: "Maintain Pipelines", - type: "category", - collapsible: false, - items: ["pipelines/maintain/updating", "pipelines/maintain/extending"], - }, - ] - } + { + label: "How it works", + type: "doc", + id: "pipelines/how-it-works/index", + }, + { + label: "Single Account Tutorial", + type: "doc", + id: "pipelines/tutorial/index", + }, + // { + // label: "Deploying Multi-Account Pipelines", + // type: "doc", + // id: "pipelines/multi-account/index", + // }, + ], + }, + { + label: "Maintain Pipelines", + type: "category", + collapsible: false, + items: ["pipelines/maintain/updating", "pipelines/maintain/extending"], + }, + { + type: "link", + label: "Knowledge Base", + href: kbLink, + }, + ], + }, ] module.exports = sidebar diff --git a/sidebars/refarch.js b/sidebars/refarch.js index 3f2e3431da..baf6e1657a 100644 --- a/sidebars/refarch.js +++ b/sidebars/refarch.js @@ -1,3 +1,8 @@ +const kbLink = + "https://github.com/orgs/gruntwork-io/discussions?discussions_q=" + + // filter by discussions with the label "s:Reference Architecture" & sort by top voted discussions first + encodeURIComponent('label:"s:Reference Architecture" sort:top') + const sidebar = [ { label: "Reference Architecture", @@ -49,6 +54,11 @@ const sidebar = [ "refarch/usage/maintain-your-refarch/undeploying", ], }, + { + type: "link", + label: "Knowledge Base", + href: kbLink, + }, ], }, ] From ebd2eec6c896e49036c7944afa47681ec231b79e Mon Sep 17 00:00:00 2001 From: Eugene K Date: Fri, 26 May 2023 10:38:24 -0400 Subject: [PATCH 2/3] Fix broken link --- _docs-sources/intro/overview/what-you-provide.md | 2 +- docs/intro/overview/what-you-provide.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/_docs-sources/intro/overview/what-you-provide.md b/_docs-sources/intro/overview/what-you-provide.md index 80b3ca2a1b..0f2e3562da 100644 --- a/_docs-sources/intro/overview/what-you-provide.md +++ b/_docs-sources/intro/overview/what-you-provide.md @@ -14,7 +14,7 @@ With Gruntwork, you can accelerate your journey towards capturing your AWS cloud Gruntwork products strike a balance between opinionatedness and configurability. They’ll get you most of the way to your goal, but you may need to make some customizations to suit your use case. You may also need to adapt your apps and services to run in your new infrastructure by customizing/adding additional Infrastructure as Code to customize according to the requirements for your company. Our [Knowledge Base](https://github.com/gruntwork-io/knowledge-base/discussions) and [Community Slack Channel](https://gruntwork-community.slack.com/archives/CHH9Y3Z62) provide great resources to assist you in this effort. -If you notice a limitation or bug in Gruntwork modules, we greatly appreciate and welcome [customer PRs](/iac/support/contributing) or you raising this to our attention via [bug or feature requests](/iac/support/issues). +If you notice a limitation or bug in Gruntwork modules, we greatly appreciate and welcome [customer PRs](/iac/support/contributing) or you raising this to our attention via [bug or feature requests](/support#share-feedback). :::note diff --git a/docs/intro/overview/what-you-provide.md b/docs/intro/overview/what-you-provide.md index c1922e595b..afc6355e19 100644 --- a/docs/intro/overview/what-you-provide.md +++ b/docs/intro/overview/what-you-provide.md @@ -14,7 +14,7 @@ With Gruntwork, you can accelerate your journey towards capturing your AWS cloud Gruntwork products strike a balance between opinionatedness and configurability. They’ll get you most of the way to your goal, but you may need to make some customizations to suit your use case. You may also need to adapt your apps and services to run in your new infrastructure by customizing/adding additional Infrastructure as Code to customize according to the requirements for your company. Our [Knowledge Base](https://github.com/gruntwork-io/knowledge-base/discussions) and [Community Slack Channel](https://gruntwork-community.slack.com/archives/CHH9Y3Z62) provide great resources to assist you in this effort. -If you notice a limitation or bug in Gruntwork modules, we greatly appreciate and welcome [customer PRs](/iac/support/contributing) or you raising this to our attention via [bug or feature requests](/iac/support/issues). +If you notice a limitation or bug in Gruntwork modules, we greatly appreciate and welcome [customer PRs](/iac/support/contributing) or you raising this to our attention via [bug or feature requests](/support#share-feedback). :::note @@ -54,6 +54,6 @@ Once deployed, Gruntwork hands the Reference Architecture over to your team. You From c9974cbb736b499932a4b924615e8141b7449353 Mon Sep 17 00:00:00 2001 From: "docs-sourcer[bot]" <99042413+docs-sourcer[bot]@users.noreply.github.com> Date: Fri, 26 May 2023 14:51:51 +0000 Subject: [PATCH 3/3] Updated `_docs-sources` with this contribution and regenerated output. --- docs/intro/overview/what-you-provide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/overview/what-you-provide.md b/docs/intro/overview/what-you-provide.md index 62471d85e5..8f0b6138ac 100644 --- a/docs/intro/overview/what-you-provide.md +++ b/docs/intro/overview/what-you-provide.md @@ -54,6 +54,6 @@ Once deployed, Gruntwork hands the Reference Architecture over to your team. You