From b5e132e607d3e618f0f4d9a0c400d8420e4a30fe Mon Sep 17 00:00:00 2001 From: Bryan Klein Date: Thu, 15 Aug 2024 01:43:25 +0000 Subject: [PATCH 1/6] Begin work on Front Matter CMS configuration. --- .frontmatter/database/mediaDb.json | 1 + .frontmatter/database/pinnedItemsDb.json | 1 + .frontmatter/database/taxonomyDb.json | 1 + .gitpod.yml | 4 +- .vscode/settings.json | 3 +- frontmatter.json | 362 ++++++++++++++++++ ...-resources-starting-journey-into-docs.adoc | 5 +- src/content/blog/keystone-project.adoc | 3 +- src/content/blog/origin-story.adoc | 3 +- src/content/blog/release-brooklyn.adoc | 5 +- src/content/blog/release-eko.adoc | 148 ++++--- .../blog/state-of-project-2022-may.adoc | 3 +- src/content/blog/tech-writing-portfolio.adoc | 5 +- .../we-are-gitlab-open-source-partners.adoc | 3 +- src/content/home.adoc | 42 +- src/content/working-groups.adoc | 22 +- 16 files changed, 507 insertions(+), 104 deletions(-) create mode 100644 .frontmatter/database/mediaDb.json create mode 100644 .frontmatter/database/pinnedItemsDb.json create mode 100644 .frontmatter/database/taxonomyDb.json create mode 100644 frontmatter.json diff --git a/.frontmatter/database/mediaDb.json b/.frontmatter/database/mediaDb.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/.frontmatter/database/mediaDb.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/.frontmatter/database/pinnedItemsDb.json b/.frontmatter/database/pinnedItemsDb.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/.frontmatter/database/pinnedItemsDb.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/.frontmatter/database/taxonomyDb.json b/.frontmatter/database/taxonomyDb.json new file mode 100644 index 0000000..726333e --- /dev/null +++ b/.frontmatter/database/taxonomyDb.json @@ -0,0 +1 @@ +{"taxonomy":{"tags":["gitlab","open-source","partnership","writers-block","writing","writing-tips"]}} \ No newline at end of file diff --git a/.gitpod.yml b/.gitpod.yml index 22073ad..3fec4ae 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,3 +1,4 @@ +--- # List the start up tasks. Learn more: https://www.gitpod.io/docs/configure/workspaces/tasks tasks: @@ -18,7 +19,6 @@ tasks: gp sync-await styles && npm run dev --watch # List the ports to expose. Learn more: https://www.gitpod.io/docs/configure/workspaces/ports - ports: - name: SvelteKit description: Port 5173 for SvelteKit Server @@ -26,7 +26,6 @@ ports: onOpen: open-browser # Installs a set of useful VS Code extensions for every workspace instance. - vscode: extensions: - svelte.svelte-vscode @@ -36,3 +35,4 @@ vscode: - sleistner.vscode-fileutils - PKief.material-icon-theme - asciidoctor.asciidoctor-vscode + - eliostruyf.vscode-front-matter-beta diff --git a/.vscode/settings.json b/.vscode/settings.json index 6167305..3d8c4bd 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,5 +5,6 @@ "workbench.editor.labelFormat": "short", "explorer.compactFolders": false, "workbench.iconTheme": "material-icon-theme", - "workbench.tree.indent": 12 + "workbench.tree.indent": 12, + "frontMatter.dashboard.openOnStart": true } diff --git a/frontmatter.json b/frontmatter.json new file mode 100644 index 0000000..cfc4a48 --- /dev/null +++ b/frontmatter.json @@ -0,0 +1,362 @@ +{ + "$schema": "https://beta.frontmatter.codes/frontmatter.schema.json", + "frontMatter.preview.host": "https://5173-tgdp-www-1rn0oma6mh9.ws-us115.gitpod.io", + "frontMatter.content.supportedFileTypes": [ + "adoc" + ], + "frontMatter.framework.id": "other", + "frontMatter.content.publicFolder": "static", + "frontMatter.content.pageFolders": [ + { + "title": "content", + "path": "[[workspace]]/src/content", + "excludeSubdir": true, + "trailingSlash": false, + "contentTypes": [ + "AsciiDoc" + ] + }, + { + "path": "[[workspace]]/src/content/tactic", + "previewPath": "/tactic/", + "trailingSlash": false, + "contentTypes": [ + "Tactic" + ] + }, + { + "path": "[[workspace]]/src/content/blog", + "previewPath": "/blog/", + "trailingSlash": false, + "contentTypes": [ + "Blog" + ] + }, + { + "title": "author", + "path": "[[workspace]]/src/content/author", + "previewPath": "/author/", + "trailingSlash": false, + "contentTypes": [ + "AsciiDoc" + ] + } + ], + "frontMatter.content.defaultFileType": "adoc", + "frontMatter.content.fmHighlight": true, + "frontMatter.content.filters": [ + "contentFolders", + "tags" + ], + "frontMatter.taxonomy.contentTypes": [ + { + "name": "AsciiDoc", + "pageBundle": false, + "fileType": "adoc", + "fields": [ + { + "title": "Content Title", + "name": "title", + "type": "string" + }, + { + "title": "Layout", + "name": "layout", + "type": "string", + "default": "blocks", + "editable": false + }, + { + "title": "Blocks", + "name": "blocks", + "type": "block", + "fieldGroup": [ + "AsciiDoc" + ] + }, + { + "title": "Last Modified", + "name": "lastmod", + "type": "datetime" + }, + { + "title": "Date", + "name": "date", + "type": "datetime" + }, + { + "title": "Featured Image", + "name": "image", + "type": "image" + }, + { + "title": "Authors", + "name": "author", + "type": "choice", + "multiple": true, + "choices": [ + "cameron_shorter", + "felicity_brand", + "good_docs", + "ryan_macklin", + "tina_luedtke" + ] + }, + { + "title": "Tags", + "name": "tags", + "type": "tags" + }, + { + "title": "Custom Copyright", + "name": "custom_copyright", + "type": "string" + }, + { + "title": "Custom License", + "name": "custom_license", + "type": "string" + }, + { + "title": "Summary", + "name": "summary", + "type": "string" + } + ] + }, + { + "name": "Blog", + "pageBundle": false, + "fileType": "adoc", + "fields": [ + { + "title": "Post Title", + "name": "title", + "type": "string" + }, + { + "title": "Summary", + "name": "summary", + "type": "string" + }, + { + "title": "Last Modified", + "name": "lastmod", + "type": "datetime" + }, + { + "title": "Date", + "name": "date", + "type": "datetime" + }, + { + "title": "Featured Image", + "name": "image", + "type": "image" + }, + { + "title": "Authors", + "name": "author", + "type": "choice", + "multiple": true, + "choices": [ + "cameron_shorter", + "felicity_brand", + "good_docs", + "ryan_macklin", + "tina_luedtke" + ] + }, + { + "title": "Tags", + "name": "tags", + "type": "tags" + }, + { + "title": "Custom Copyright", + "name": "custom_copyright", + "type": "string" + }, + { + "title": "Custom License", + "name": "custom_license", + "type": "string" + } + ] + }, + { + "name": "Tactic", + "pageBundle": false, + "fileType": "adoc", + "fields": [ + { + "title": "Tactic Title", + "name": "title", + "type": "string" + }, + { + "title": "Summary", + "name": "summary", + "type": "string" + }, + { + "title": "Layout", + "name": "layout", + "type": "string", + "default": "blocks", + "editable": false + }, + { + "title": "Blocks", + "name": "blocks", + "type": "block", + "fieldGroup": [ + "AsciiDoc" + ] + }, + { + "title": "Last Modified", + "name": "lastmod", + "type": "datetime" + }, + { + "title": "Date", + "name": "date", + "type": "datetime" + }, + { + "title": "Featured Image", + "name": "image", + "type": "image" + }, + { + "title": "Authors", + "name": "author", + "type": "choice", + "multiple": true, + "choices": [ + "cameron_shorter", + "felicity_brand", + "good_docs", + "ryan_macklin", + "tina_luedtke" + ] + }, + { + "title": "Tags", + "name": "tags", + "type": "tags" + }, + { + "title": "Custom Copyright", + "name": "custom_copyright", + "type": "string" + }, + { + "title": "Custom License", + "name": "custom_license", + "type": "string" + } + ] + } + ], + "frontMatter.taxonomy.fieldGroups": [ + { + "id": "AsciiDoc", + "labelField": "title", + "fields": [ + { + "title": "Title", + "name": "title", + "type": "string", + "single": true + }, + { + "title": "Block ref", + "name": "block_ref", + "type": "string", + "single": true + } + ] + } + ], + "frontMatter.data.files": [ + { + "id": "navmenu", + "title": "Nav Menus", + "file": "[[workspace]]/src/lib/navMenu.json", + "fileType": "json", + "labelField": "text", + "singleEntry": true, + "schema": { + "title": "Nav Menu", + "type": "object", + "properties": { + "top": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "url": { + "type": "string" + }, + "key": { + "type": "string", + "optional": true + }, + "subnav": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "text", + "url" + ] + }, + "optional": true + } + }, + "required": [ + "text" + ] + } + }, + "footer": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "text", + "url" + ] + } + } + }, + "required": [ + "top", + "footer" + ] + } + } + ], + "frontMatter.git.enabled": false +} \ No newline at end of file diff --git a/src/content/blog/6-resources-starting-journey-into-docs.adoc b/src/content/blog/6-resources-starting-journey-into-docs.adoc index 2d935b1..ed10662 100644 --- a/src/content/blog/6-resources-starting-journey-into-docs.adoc +++ b/src/content/blog/6-resources-starting-journey-into-docs.adoc @@ -1,15 +1,14 @@ --- -draft: false title: 6 resources for starting your journey into docs! date: 2022-07-19T21:58:42.336Z -lastmod: 2022-09-26T17:06:12.081Z +lastmod: 2024-08-15T01:07:33.669Z image: Matthew-Sleeper.jpg author: - tina_luedtke tags: - writing-tips - learn-tech-writing -custom_copyright: +custom_copyright: null custom_license: Photo by Matthew Sleeper on Unsplash. summary: Do you find yourself in the shoes of someone who has to write documentation for the first time ever? The closer you look, the more you will find that technical writing is actually quite a broad discipline. Amidst the tons of resources, it can be hard to figure out what you need to know to get started. So here are six resources to narrow that space for you. --- diff --git a/src/content/blog/keystone-project.adoc b/src/content/blog/keystone-project.adoc index ea607d6..0eb7f62 100644 --- a/src/content/blog/keystone-project.adoc +++ b/src/content/blog/keystone-project.adoc @@ -1,8 +1,7 @@ --- -draft: false title: Becoming a Keystone Project date: 2023-05-15 -lastmod: 2023-05-23T07:31:23.243Z +lastmod: 2024-08-15T01:07:33.685Z image: keystone.png author: - cameron_shorter diff --git a/src/content/blog/origin-story.adoc b/src/content/blog/origin-story.adoc index b412f8e..9bccc54 100644 --- a/src/content/blog/origin-story.adoc +++ b/src/content/blog/origin-story.adoc @@ -1,8 +1,7 @@ --- -draft: false title: Origin Story - Birth of The Good Docs Project date: 2023-06-08 -lastmod: 2023-06-08T05:05:35.657Z +lastmod: 2024-08-15T01:07:33.678Z image: babydoctopus.png author: - good_docs diff --git a/src/content/blog/release-brooklyn.adoc b/src/content/blog/release-brooklyn.adoc index 46576d8..ca77290 100644 --- a/src/content/blog/release-brooklyn.adoc +++ b/src/content/blog/release-brooklyn.adoc @@ -1,8 +1,7 @@ --- -draft: false title: Template release 0.3.0 & using our own templates date: 2022-12-16T02:25:48.062Z -lastmod: 2022-12-18T00:29:07.555Z +lastmod: 2024-08-15T01:07:33.684Z image: release-brooklyn.png author: - ryan_macklin @@ -11,7 +10,7 @@ tags: - releases - testing custom_copyright: "" -custom_license: "Photo by Michał Ludwiczak via pexels." +custom_license: Photo by Michał Ludwiczak via pexels. summary: The Brooklyn release introduced four new templates. We also share some lessons from using our own templates. --- diff --git a/src/content/blog/release-eko.adoc b/src/content/blog/release-eko.adoc index e519b5f..9a79269 100644 --- a/src/content/blog/release-eko.adoc +++ b/src/content/blog/release-eko.adoc @@ -1,28 +1,30 @@ --- -draft: false title: The Eko (v1.2) release is here! date: 2024-06-13 -lastmod: 2024-06-13 +lastmod: 2024-08-15T01:42:04.239Z image: release-eko.jpg author: - good_docs tags: - the-project - releases - custom_copyright: "" custom_license: "" summary: The Eko release introduced three new templates. We also share some community news. --- -For several months, The https://thegooddocsproject.dev[The Good Docs Project] - has been working hard on the https://gitlab.com/tgdp/templates/-/releases/v1.2.0[version 1.2.0] (codenamed "Eko"). - Why "Eko"? We name our releases after bridges, since we are bridging the documentation gap in open source and beyond. - The Eko bridge is located in Lagos, Nigeria. Fun Fact: We have several contributors from Nigeria, many of whom are leaders or prominent members in our community. +For several months, The https://thegooddocsproject.dev[The Good Docs Project] has been working hard on the https://gitlab.com/tgdp/templates/-/releases/v1.2.0[version 1.2.0] (codenamed "Eko"). +Why "Eko"? We name our releases after bridges, since we are bridging the documentation gap in open source and beyond. +The Eko bridge is located in Lagos, Nigeria. +Fun Fact: We have several contributors from Nigeria, many of whom are leaders or prominent members in our community. ## Eko templates -Our community is a group of people that are passionate about making documentation easy to write and read. We believe everyone deserves to read good documentation and that everyone should be empowered to write good documentation. Some of the top reasons why non-tech writers struggle with documentation are fear of the blank page or not knowing how to scope information. Our https://www.thegooddocsproject.dev/template[templates] help them overcome these hurdles and create great docs! +Our community is a group of people that are passionate about making documentation easy to write and read. +We believe everyone deserves to read good documentation and that everyone should be empowered to write good documentation. +Some of the top reasons why non-tech writers struggle with documentation are fear of the blank page or not knowing how to scope information. +Our https://www.thegooddocsproject.dev/template[templates] help them overcome these hurdles and create great docs! + The Eko release intrdouces three new templates: @@ -30,26 +32,33 @@ The Eko release intrdouces three new templates: * Glossary * User personas -Let's take a closer look at these templates! +Let's take a closer look at these templates! ### Contact support template -The Contact support template authored by community member, Christine Belzie, is a fantastic starting point for you to create a contact support page for your project. A contact support page typically consists of communication channels, discussion forums and links to other resources to assist your users with issues that they are having with your product. This page can also provide insights into the user experience, which can be helpful in improving the product and the onboarding process. +The Contact support template authored by community member, Christine Belzie, is a fantastic starting point for you to create a contact support page for your project. +A contact support page typically consists of communication channels, discussion forums and links to other resources to assist your users with issues that they are having with your product. +This page can also provide insights into the user experience, which can be helpful in improving the product and the onboarding process. -Christine is a a member of the Team Alpaca https://www.thegooddocsproject.dev/working-groups#_templates[templates] working group. She has been actively working on this template for close to year. When asked about her template writing process, Christine shared: +Christine is a a member of the Team Alpaca https://www.thegooddocsproject.dev/working-groups#_templates[templates] working group. +She has been actively working on this template for close to year. +When asked about her template writing process, Christine shared: [quote, Christine Belzie] ____ -To create this template and its accompanying resources, I initially wrote it from the perspective of the customer. However after talking to senior project members, Alyssa Rock and Cameron Shorter, I realized that the final draft should also include information on how the company influences the creation of a contact support page. -So, I did some in-depth research on topics such as customer service strategies and customer satisfaction rates, then added this information. +To create this template and its accompanying resources, I initially wrote it from the perspective of the customer. +However after talking to senior project members, Alyssa Rock and Cameron Shorter, I realized that the final draft should also include information on how the company influences the creation of a contact support page. +So, I did some in-depth research on topics such as customer service strategies and customer satisfaction rates, then added this information. ____ Check out the https://gitlab.com/tgdp/templates/-/tree/main/contact-support?ref_type=heads[Contact support template] in our https://gitlab.com/tgdp/templates[templates] GitLab repository! ### Glossary template -The glossary template authored by community member, Rachel Stainer, is an excellent addition to The Good Docs Project's template suite as it was one of the most highly requested content types when we first created our template roadmap. The glossary template will assist us in forming the foundation for other important work in the glossary working group and The Chronologue. Rachel researched and worked on this template for nearly a year as a member of the Team Alpaca https://www.thegooddocsproject.dev/working-groups#_templates[templates] working group. +The glossary template authored by community member, Rachel Stainer, is an excellent addition to The Good Docs Project's template suite as it was one of the most highly requested content types when we first created our template roadmap. +The glossary template will assist us in forming the foundation for other important work in the glossary working group and The Chronologue. +Rachel researched and worked on this template for nearly a year as a member of the Team Alpaca https://www.thegooddocsproject.dev/working-groups#_templates[templates] working group. You can use our glossary template to help identify and document terms and definitions related to a specific topic that may be unfamiliar to your reader or product user. @@ -58,17 +67,28 @@ https://gitlab.com/tgdp/templates[templates] GitLab repository! ### User personas template -Last but not least, we are very excited to release our user personas template authored by project member and Team Alpaca template https://www.thegooddocsproject.dev/our-team#_working_group_leads[working group lead], Ailine Dominey. The primary purpose of user personas is to guide teams and stakeholders toward decisions that are closely aligned to user needs. You can use our template to fill out your relevant user characteristics to create user personas for your project. +Last but not least, we are very excited to release our user personas template authored by project member and Team Alpaca template https://www.thegooddocsproject.dev/our-team#_working_group_leads[working group lead], Ailine Dominey. +The primary purpose of user personas is to guide teams and stakeholders toward decisions that are closely aligned to user needs. +You can use our template to fill out your relevant user characteristics to create user personas for your project. -Ailine thoroughly researched this template, beginning in the summer of 2023. She planned and conducted a user persona research project for the https://github.com/saltstack[Salt Project] which led to her documenting real user personas. As a result of her research and hard work, she received highly positive feedback from the Salt user community and maintainers. When asked about her template writing process, Ailine shared: +Ailine thoroughly researched this template, beginning in the summer of 2023. +She planned and conducted a user persona research project for the https://github.com/saltstack[Salt Project] which led to her documenting real user personas. +As a result of her research and hard work, she received highly positive feedback from the Salt user community and maintainers. +When asked about her template writing process, Ailine shared: [quote, Ailine Dominey] ____ -Prior to working on the user personas template, I had a limited understanding of personas. It's easy to overlook their value until you have the chance to create and apply them. Thankfully, I had the opportunity to work with Alyssa Rock, a phenomenal mentor, to create user personas as part of a larger effort to improve documentation for the Salt Project. Through that open-source project, we conducted user research to establish the Salt user personas. +Prior to working on the user personas template, I had a limited understanding of personas. +It's easy to overlook their value until you have the chance to create and apply them. +Thankfully, I had the opportunity to work with Alyssa Rock, a phenomenal mentor, to create user personas as part of a larger effort to improve documentation for the Salt Project. +Through that open-source project, we conducted user research to establish the Salt user personas. -The real-world experience gained from the Salt Project, combined with abundant, valuable feedback from community members of The Good Docs Project, helped shape the user personas template. Our goal was to create a template that provides essential considerations for developing the kind of user personas that serve as effective guides for making user-responsive product decisions. Personally, I see the takeaway benefits for user personas as follows: they give you a birds-eye view of what makes each type of user distinct, and at the same time, tap into the behind-the-screen motivations that drive each user in their interaction with your product or project. +The real-world experience gained from the Salt Project, combined with abundant, valuable feedback from community members of The Good Docs Project, helped shape the user personas template. +Our goal was to create a template that provides essential considerations for developing the kind of user personas that serve as effective guides for making user-responsive product decisions. +Personally, I see the takeaway benefits for user personas as follows: they give you a birds-eye view of what makes each type of user distinct, and at the same time, tap into the behind-the-screen motivations that drive each user in their interaction with your product or project. -I'm grateful to everyone who took the time to share their feedback on the TGDP user personas template. I hope it will be helpful to those looking to bring more user perspective into their work. +I'm grateful to everyone who took the time to share their feedback on the TGDP user personas template. +I hope it will be helpful to those looking to bring more user perspective into their work. ____ Check out the https://gitlab.com/tgdp/templates/-/tree/main/user-personas[User personas template] in our @@ -76,16 +96,21 @@ https://gitlab.com/tgdp/templates[templates] GitLab repository! ### Templates style guide When writing our templates, our templateeers reference our https://gitlab.com/tgdp/templates/-/blob/main/STYLE-GUIDE.md?ref_type=heads[style guide]. -Our style guide empowers community members to create templates that are consistent in style and tone. The great, big process of creating our style guide was led by Ane Tröger, in collaboration with the https://www.thegooddocsproject.dev/our-team#_template_product_management_team[template product management] team and https://www.thegooddocsproject.dev/our-team#_template_editorial_team[template editorial team]. Well done, Ane! +Our style guide empowers community members to create templates that are consistent in style and tone. +The great, big process of creating our style guide was led by Ane Tröger, in collaboration with the https://www.thegooddocsproject.dev/our-team#_template_product_management_team[template product management] team and https://www.thegooddocsproject.dev/our-team#_template_editorial_team[template editorial team]. +Well done, Ane! + ## Community news -Our community has been hard at work ever since its inception in 2019. We'd like to congratulate Cameron Shorter, one of our -founding members on 5 years of being a cornerstone of this community. -After running several review sessions and collaborating with many community members, Cameron created our https://gitlab.com/tgdp/governance/-/blob/main/DocCommentingGuide.md[commenting guide for collaborative document reviews]. This guide shares numerous practical tips for both authors and reviewers for a productive and succesful review session. +Our community has been hard at work ever since its inception in 2019. +We'd like to congratulate Cameron Shorter, one of our founding members on 5 years of being a cornerstone of this community. +After running several review sessions and collaborating with many community members, Cameron created our https://gitlab.com/tgdp/governance/-/blob/main/DocCommentingGuide.md[commenting guide for collaborative document reviews]. +This guide shares numerous practical tips for both authors and reviewers for a productive and succesful review session. -There's more achievements to celebrate! Lana Novikova was awarded an Open Source Peer Bonus from Google for her contributions with the project. +There's more achievements to celebrate! +Lana Novikova was awarded an Open Source Peer Bonus from Google for her contributions with the project. ### Project steering committee Our https://www.thegooddocsproject.dev/our-team#_project_steering_committee[project steering committee] has grown and we are thrilled to welcome the following contributors into our leadership team: @@ -99,40 +124,57 @@ Our https://www.thegooddocsproject.dev/our-team#_project_steering_committee[proj ### Co-chairs -The Good Docs Project has welcomed Michael Park as our new co-chair! Michael is now co-chairing the project with Tina Lüdtke. Carrie Wattula has completed her two year term as a co-chair and we thank her for her service. - +The Good Docs Project has welcomed Michael Park as our new co-chair! +Michael is now co-chairing the project with Tina Lüdtke. +Carrie Wattula has completed her two year term as a co-chair and we thank her for her service. ### Tech team -The https://www.thegooddocsproject.dev/our-team#_tech_team[Tech team] has been working closely in cooperation with the UX and Outreach team to overhaul our website. Our website now has a fresh new design with streamlined navigation that makes it easy for people to learn about our project and join our community. This was a massive effort and we're excited to reveal it as part of the Eko release. +The https://www.thegooddocsproject.dev/our-team#_tech_team[Tech team] has been working closely in cooperation with the UX and Outreach team to overhaul our website. +Our website now has a fresh new design with streamlined navigation that makes it easy for people to learn about our project and join our community. +This was a massive effort and we're excited to reveal it as part of the Eko release. -Alongside our blog and template guides, you can now find our latest The Good Docs Project offering, https://www.thegooddocsproject.dev/tactic[Tatics]. Tactics are a series of articles that provide guidance and best practices on a variety of topics related to improving your documentation. +Alongside our blog and template guides, you can now find our latest The Good Docs Project offering, https://www.thegooddocsproject.dev/tactic[Tatics]. +Tactics are a series of articles that provide guidance and best practices on a variety of topics related to improving your documentation. ### UX and Outreach -In addition to working closely on the website with the Tech team, https://www.thegooddocsproject.dev/our-team#_community_managers[UX and Outreach] has focused their energy on conducting user research and growing our core user base. This group researched and drafted our https://docs.google.com/document/d/11sK7iuT25vbd3XgfGoahxQ9SkyI0kv7kAzPNAH8-Abg/edit[Outreach Strategy] which defines our users journey from initial discovery of our templates to successfully implementing our templates in their projects and sharing their success stories with others. The Outreach Strategy explains what future content and initiatives we will create to take our users through this journey. +In addition to working closely on the website with the Tech team, https://www.thegooddocsproject.dev/our-team#_community_managers[UX and Outreach] has focused their energy on conducting user research and growing our core user base. +This group researched and drafted our https://docs.google.com/document/d/11sK7iuT25vbd3XgfGoahxQ9SkyI0kv7kAzPNAH8-Abg/edit[Outreach Strategy] which defines our users journey from initial discovery of our templates to successfully implementing our templates in their projects and sharing their success stories with others. +The Outreach Strategy explains what future content and initiatives we will create to take our users through this journey. -The UX and Outreach working group wants to hear from you! We encourage you to take our https://www.cognitoforms.com/gooddocsproject/documentationmaintainersurvey[doc maintainers survey] and share your experiences with us so that we can identify how to best help you in creating and maintaining great documentation effectively. +The UX and Outreach working group wants to hear from you! +We encourage you to take our https://www.cognitoforms.com/gooddocsproject/documentationmaintainersurvey[doc maintainers survey] and share your experiences with us so that we can identify how to best help you in creating and maintaining great documentation effectively. -The Good Docs Project's co-chair and UX working group leader, Tina Lüdtke presented at the Linux Foundation's Open Source Summit - North America 2024. Check out https://ossna2024.sched.com/event/1aEsl/know-your-audience-a-look-inside-the-human-brain-tina-luedtke-google[Tina's talk], where she shares the importance of understanding your users so that you can create documentation that is clear, concise and easy to understand. +The Good Docs Project's co-chair and UX working group leader, Tina Lüdtke presented at the Linux Foundation's Open Source Summit - North America 2024. +Check out https://ossna2024.sched.com/event/1aEsl/know-your-audience-a-look-inside-the-human-brain-tina-luedtke-google[Tina's talk], where she shares the importance of understanding your users so that you can create documentation that is clear, concise and easy to understand. -Tina also recently presented on the https://www.brighttalk.com/channel/9273/[The Content Wrangler], where she introduced The Good Docs Project. In her https://www.brighttalk.com/webcast/9273/610219?utm_source=brighttalk-portal&utm_medium=web&utm_campaign=channel-page&utm_content=recorded[talk], Tina shared how our community fosters collaboration among technical writers, software developers and UX designers while providing mentorship and networking opportunities. +Tina also recently presented on the https://www.brighttalk.com/channel/9273/[The Content Wrangler], where she introduced The Good Docs Project. +In her https://www.brighttalk.com/webcast/9273/610219?utm_source=brighttalk-portal&utm_medium=web&utm_campaign=channel-page&utm_content=recorded[talk], Tina shared how our community fosters collaboration among technical writers, software developers and UX designers while providing mentorship and networking opportunities. ### Community managers -The https://www.thegooddocsproject.dev/our-team#_community_managers[community managers] welcomed Cat Keller to the team. Cat is leading our initiative of "Fostering a positive community culture". We're excited to see what interesting ideas she brings about how to best meet this objective! +The https://www.thegooddocsproject.dev/our-team#_community_managers[community managers] welcomed Cat Keller to the team. +Cat is leading our initiative of "Fostering a positive community culture". +We're excited to see what interesting ideas she brings about how to best meet this objective! -As part of the community management team's initiative to onboard, mentor and train community members, The Good Docs Project launched our Welcome Wagon meeting program last year. +As part of the community management team's initiative to onboard, mentor and train community members, The Good Docs Project launched our Welcome Wagon meeting program last year. -The Welcome Wagon meetings are hosted by Alyssa Rock and Michael Vallance. Our working group leads and seasoned community members also join as welcomers. The purpose of the Welcome Wagon is to introduce welcomees to the community, familiarize them with our https://www.thegooddocsproject.dev/code-of-conduct[Code of Conduct], discuss their interests and connect them to leaders of the working group of their choice. +The Welcome Wagon meetings are hosted by Alyssa Rock and Michael Vallance. +Our working group leads and seasoned community members also join as welcomers. +The purpose of the Welcome Wagon is to introduce welcomees to the community, familiarize them with our https://www.thegooddocsproject.dev/code-of-conduct[Code of Conduct], discuss their interests and connect them to leaders of the working group of their choice. -Due to the great success of the Welcome Wagon, we offer friendly meeting times in the AMER, EMEA and APAC regions. This release cycle is the first cycle where our community has offered additional Welcome Wagon time slots for contributors in APAC and EMEA to give them more meeting time options. +Due to the great success of the Welcome Wagon, we offer friendly meeting times in the AMER, EMEA and APAC regions. +This release cycle is the first cycle where our community has offered additional Welcome Wagon time slots for contributors in APAC and EMEA to give them more meeting time options. + -The majority of newcomers that have attended our Welcome Wagon are located in the West Africa Time (WAT) timezone (18%). Welcome! +The majority of newcomers that have attended our Welcome Wagon are located in the West Africa Time (WAT) timezone (18%). +Welcome! image::Welcome-Wagon-timezone-chart.png[Chart tracking Good Docs Welcome Wagon attendance based on time zone.,title="Welcome Wagon welcomees by timezone for The Good Docs Project"] -How do newcomers hear about us? The majority of welcomees found us through internet search (27.5%). Before attending the Welcome Wagon, many folks heard about us from active community members (7.5%). +How do newcomers hear about us? The majority of welcomees found us through internet search (27.5%). +Before attending the Welcome Wagon, many folks heard about us from active community members (7.5%). image::Welcome-Wagon-from-chart.png[Chart tracking Good Docs Welcome Wagon attendance based on how they heard about the project.,title="How did you hear about The Good Docs Project?"] @@ -140,27 +182,21 @@ If you are interested in learning more about The Good Docs Project, we invite yo ## A look ahead -Recently, a few tooling providers and other organizations have stated their interest to incorporate our templates into their products and processes and establish a more formal relationship with us. We see this as an exciting tipping point and validation of the value our templates and community bring. -It introduces both opportunities and challenges for us. We are in the process of establishing a partner program, and inviting potential partners to help us shape such a program. +Recently, a few tooling providers and other organizations have stated their interest to incorporate our templates into their products and processes and establish a more formal relationship with us. +We see this as an exciting tipping point and validation of the value our templates and community bring. +It introduces both opportunities and challenges for us. +We are in the process of establishing a partner program, and inviting potential partners to help us shape such a program. -To read about our exciting partnership with GitLab, see the the partnership announcment on the https://about.gitlab.com/solutions/open-source/partners/[GitLab Open Source Partners] page and our blost post, https://www.thegooddocsproject.dev/blog/we-are-gitlab-open-source-partners[We are GitLab Open Source Partners]. - -A huge thank-you to all our contributors and collaborators on the Eko release! With your great contributions, we can continue to grow a supportive, diverse, passionate, and fun-loving community. +To read about our exciting partnership with GitLab, see the the partnership announcment on the https://about.gitlab.com/solutions/open-source/partners/[GitLab Open Source Partners] page and our blost post, https://www.thegooddocsproject.dev/blog/we-are-gitlab-open-source-partners[We are GitLab Open Source Partners]. +A huge thank-you to all our contributors and collaborators on the Eko release! +With your great contributions, we can continue to grow a supportive, diverse, passionate, and fun-loving community. Help us improve in the next release: -* If you have 5 minutes and a project lined up: Use our templates! Every template has a survey link at the bottom, so let us know how it went. - -* If you have 10 minutes: Take our https://www.cognitoforms.com/gooddocsproject/documentationmaintainersurvey[doc maintainers survey]. We can prioritize work aids for content maintainers, if we understand their pain points. - -* If you have 2-3 hours per week: Feel free to share your documentation best practices as a contributor. - - - - - - - - +* If you have 5 minutes and a project lined up: Use our templates! +Every template has a survey link at the bottom, so let us know how it went. +* If you have 10 minutes: Take our https://www.cognitoforms.com/gooddocsproject/documentationmaintainersurvey[doc maintainers survey]. +We can prioritize work aids for content maintainers, if we understand their pain points. +* If you have 2-3 hours per week: Feel free to share your documentation best practices as a contributor. \ No newline at end of file diff --git a/src/content/blog/state-of-project-2022-may.adoc b/src/content/blog/state-of-project-2022-may.adoc index 3cb9c3c..5d635bc 100644 --- a/src/content/blog/state-of-project-2022-may.adoc +++ b/src/content/blog/state-of-project-2022-may.adoc @@ -1,8 +1,7 @@ --- -draft: false title: State of The Good Docs Project, May 2022 date: 2022-05-21T16:00:00Z -lastmod: +lastmod: 2024-08-15T01:07:33.680Z image: state-of-project-2022-may.jpg author: - ryan_macklin diff --git a/src/content/blog/tech-writing-portfolio.adoc b/src/content/blog/tech-writing-portfolio.adoc index 83db873..d9d8427 100644 --- a/src/content/blog/tech-writing-portfolio.adoc +++ b/src/content/blog/tech-writing-portfolio.adoc @@ -1,8 +1,7 @@ --- -draft: false title: Marketing yourself - Why you need a tech writing portfolio date: 2022-05-21T16:00:00Z -lastmod: 2024-05-13T17:12:57.612Z +lastmod: 2024-08-15T01:07:33.683Z image: davisuko-5E5N49RWtbA-unsplash.jpg author: - felicity_brand @@ -10,7 +9,7 @@ tags: - writing - job-hunting custom_copyright: "" -custom_license: "Photo by davisuko via Unsplash" +custom_license: Photo by davisuko via Unsplash summary: The Brooklyn release introduced four new templates. We also share some lessons from using our own templates. --- A writing portfolio is a collection of samples of your own writing-basically, it shows *what you can do*. A strong portfolio goes further and shows *how you think*. Whether it's private or public, it's a good idea to have one, and they're not as hard to create as you might think. diff --git a/src/content/blog/we-are-gitlab-open-source-partners.adoc b/src/content/blog/we-are-gitlab-open-source-partners.adoc index e44920e..5c18356 100644 --- a/src/content/blog/we-are-gitlab-open-source-partners.adoc +++ b/src/content/blog/we-are-gitlab-open-source-partners.adoc @@ -1,8 +1,7 @@ --- -draft: false title: We Are GitLab Open Source Partners date: 2023-06-20 -lastmod: 2023-06-20T01:39:20.842Z +lastmod: 2024-08-15T01:07:33.673Z image: doctopus-and-red-fox.png author: - good_docs diff --git a/src/content/home.adoc b/src/content/home.adoc index 7417496..9d2abab 100644 --- a/src/content/home.adoc +++ b/src/content/home.adoc @@ -1,16 +1,16 @@ --- -title: "The Good Docs Project" +title: The Good Docs Project layout: blocks -blocks: - - block_ref: 'hero' +blocks: + - block_ref: hero title: You have great software, but how do you explain it to the world? subtitle: Our templates help you create quality documentation faster and easier. video: filename: home_page_video.mp4 alt: Happy people writing docs. - image: - filename: - alt: + image: + filename: null + alt: null cta_top: text: See the "Eko" release v1.2.0 of our Templates! link: https://gitlab.com/tgdp/templates/-/releases/v1.2.0 @@ -19,53 +19,53 @@ blocks: - link: https://gitlab.com/tgdp/templates/-/releases/v1.2.0 link_text: Show me the templates button: true - - block_ref: 'announce' + - block_ref: announce title: Everything we offer is open source, at no cost to you. subtitle: The Good Docs Project is a large, global community of volunteers who are passionate about empowering developers to create good documentation. - - block_ref: 'split_with_image' + - block_ref: split_with_image toptitle: Leverage our shared expertise title: Your software is amazing, but what if nobody can use it? text: Your docs could help, but where will you find the time to write docs when you're too busy solving problems with code? Our templates can help. Dive into our resources and get productive right away. image: filename: thinking-about-docs.jpg alt: People working on documentaion together. - color: + color: null ctas: - link: https://gitlab.com/tgdp/templates/-/releases/v1.2.0 link_text: Show me the templates button: true - - block_ref: 'simple_3_column_with_large_icons' + - block_ref: simple_3_column_with_large_icons title: Good documentation empowers software users and development teams - text: + text: null cols: - icon: - code: '' + code: color: white background: tgdp-blue title: Onboard users faster text: Good documentation helps new users get started with your software quickly and easily. - icon: - code: '' + code: color: tgdp-blue background: tgdp-sun title: reduce time spent on support text: Effective documentation reduces the time your team spends resolving support issues by helping users to help themselves. - icon: - code: '' + code: color: white background: tgdp-disco title: overcome writer's block text: All developers can write great documentation once they have the right tools to guide them. - - block_ref: 'testimonial_with_overlapping_image' + - block_ref: testimonial_with_overlapping_image quote: text: We get it. We know how hard it is to get the right information into your docs.

Our community of 75+ experienced technical writers can help with that--and for free! - name: - role: + name: null + role: null show_marks: false image: filename: business-friends.jpg alt: Happy Documentarian who is here to help. - - block_ref: 'steps' + - block_ref: steps title: "How it works:" steps: - value: 1 @@ -77,11 +77,15 @@ blocks: - value: 3 text: Write great docs link: https://gitlab.com/tgdp/templates/-/releases/v1.2.0 - - block_ref: 'content_with_image' + - block_ref: content_with_image title: Progress is only a few steps away image: filename: high-five-extended.jpg alt: Happy Documentarian who is here to help. +lastmod: 2024-08-15T01:00:27.956Z +summary: |- + We believe everyone deserves to read good documentation and that everyone should be empowered to write good documentation. + That's why our community of technical writers created a full suite of templates to guide you and your team through the process of creating great documentation. --- At The Good Docs Project, we know you want to provide your users with information to easily use and understand your software. diff --git a/src/content/working-groups.adoc b/src/content/working-groups.adoc index 604d76e..5dd853a 100644 --- a/src/content/working-groups.adoc +++ b/src/content/working-groups.adoc @@ -4,6 +4,7 @@ layout: blocks blocks: - block_ref: content title: Working Groups +lastmod: 2024-08-15T00:36:52.530Z --- Our project mission statement: @@ -18,15 +19,16 @@ You can join any one of these working groups and start contributing to the proje A working group consists of two or more project contributors who are collaborating together to work on a Good Docs Project initiative or focus area of the project. - == Who can join? If you are new to The Good Docs Project, begin by filling out the link:/join-us[Welcome Wagon registration form] to receive an invitation to the project. -After you've joined the project, all working groups are open for anyone to join as a general rule. Contributors can belong to as many working groups as they have time for and it's okay to join a group to observe for a while before contributing. +After you've joined the project, all working groups are open for anyone to join as a general rule. +Contributors can belong to as many working groups as they have time for and it's okay to join a group to observe for a while before contributing. If you are interested in contributing to a working group: -- Talk to the working group lead(s). See link:/our-team[Our Team] for information about the current working group leads. +- Talk to the working group lead(s). +See link:/our-team[Our Team] for information about the current working group leads. - Join the working group Slack channel(s). - Check the link:/calendar[https://thegooddocsproject.dev/community/#calendar] for meeting times and join a meeting. @@ -35,14 +37,15 @@ If you are interested in contributing to a working group: The various working groups generally meet weekly or bi-weekly for an hour. Most community members give about 1-2 hours of their time every week by participating in one of these groups. -Always remember that we'll take what you can give. You and your family come first, then work, then volunteering. -If you can't keep your working group commitments, that's okay. Just let your working group leader know. - +Always remember that we'll take what you can give. +You and your family come first, then work, then volunteering. +If you can't keep your working group commitments, that's okay. +Just let your working group leader know. == Which working groups are available? -We have four working groups you can join. Each working group has meeting times available for all time zone regions. - +We have four working groups you can join. +Each working group has meeting times available for all time zone regions. === image:avatar-templates.png[Templates Avatar,64,64,role="inline"] Templates @@ -50,7 +53,8 @@ This is our main working group. This group creates templates and guides to help people write the most common documentation content types. You can explore our templates suite to see some of the templates that have been built so far and think about contributing one of your own! -Join this group if you're interested in contributing to our core project. This group is especially good for contributors who are experienced technical writers or software engineers. +Join this group if you're interested in contributing to our core project. +This group is especially good for contributors who are experienced technical writers or software engineers. * link:https://docs.google.com/document/d/1iRxB0T7FoVjIeG_LawbCzcLfXCILlpFdzn-4BPDGR9Y/edit?usp=sharing[Group Notes] * **Slack channel:** #templates -- GitLab From 2a4787231f9a11acae10875dceb4736d910eb733 Mon Sep 17 00:00:00 2001 From: Bryan Klein Date: Thu, 15 Aug 2024 02:15:04 +0000 Subject: [PATCH 2/6] More tweaks. --- frontmatter.json | 84 +++++++++++++++++++------------- src/content/tactic/ia-guide.adoc | 1 + 2 files changed, 51 insertions(+), 34 deletions(-) diff --git a/frontmatter.json b/frontmatter.json index cfc4a48..c9c87b5 100644 --- a/frontmatter.json +++ b/frontmatter.json @@ -1,10 +1,12 @@ { "$schema": "https://beta.frontmatter.codes/frontmatter.schema.json", "frontMatter.preview.host": "https://5173-tgdp-www-1rn0oma6mh9.ws-us115.gitpod.io", + "frontMatter.framework.id": "other", + "frontMatter.framework.startCommand": "npm run dev", + "frontMatter.dashboard.openOnStart": true, "frontMatter.content.supportedFileTypes": [ "adoc" ], - "frontMatter.framework.id": "other", "frontMatter.content.publicFolder": "static", "frontMatter.content.pageFolders": [ { @@ -92,15 +94,8 @@ { "title": "Authors", "name": "author", - "type": "choice", - "multiple": true, - "choices": [ - "cameron_shorter", - "felicity_brand", - "good_docs", - "ryan_macklin", - "tina_luedtke" - ] + "type": "fieldCollection", + "fieldGroup": "author" }, { "title": "Tags", @@ -157,15 +152,8 @@ { "title": "Authors", "name": "author", - "type": "choice", - "multiple": true, - "choices": [ - "cameron_shorter", - "felicity_brand", - "good_docs", - "ryan_macklin", - "tina_luedtke" - ] + "type": "fieldCollection", + "fieldGroup": "author" }, { "title": "Tags", @@ -204,7 +192,13 @@ "name": "layout", "type": "string", "default": "blocks", - "editable": false + "hidden": true + }, + { + "title": "Authors", + "name": "author", + "type": "fieldCollection", + "fieldGroup": "author" }, { "title": "Blocks", @@ -227,20 +221,8 @@ { "title": "Featured Image", "name": "image", - "type": "image" - }, - { - "title": "Authors", - "name": "author", - "type": "choice", - "multiple": true, - "choices": [ - "cameron_shorter", - "felicity_brand", - "good_docs", - "ryan_macklin", - "tina_luedtke" - ] + "type": "image", + "isPreviewImage": true }, { "title": "Tags", @@ -278,6 +260,40 @@ "single": true } ] + }, + { + "id": "author", + "labelField": "title", + "fields": [ + { + "title": "Author", + "name": "author", + "type": "choice", + "multiple": true, + "choices": [ + { + "id": "cameron_shorter", + "title": "Cameron Shorter" + }, + { + "id": "felicity_brand", + "title": "Felicity Brand" + }, + { + "id": "good_docs", + "title": "TGDP Contributors" + }, + { + "id": "ryan_macklin", + "title": "Ryan Macklin" + }, + { + "id": "tina_luedtke", + "title": "Tina Luedtke" + } + ] + } + ] } ], "frontMatter.data.files": [ diff --git a/src/content/tactic/ia-guide.adoc b/src/content/tactic/ia-guide.adoc index d039aec..4547dfc 100644 --- a/src/content/tactic/ia-guide.adoc +++ b/src/content/tactic/ia-guide.adoc @@ -11,6 +11,7 @@ layout: blocks blocks: - block_ref: content title: Let your readers be the guide +lastmod: 2024-08-15T02:14:45.214Z --- == Introduction -- GitLab From fdd4e61b4e4fa991ffbcb9c569610a39ae590155 Mon Sep 17 00:00:00 2001 From: "Bryan Klein (TECi)" Date: Thu, 15 Aug 2024 16:28:09 +0000 Subject: [PATCH 3/6] Update .gitpod.yml --- .gitpod.yml | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index 3fec4ae..eafa9c0 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -2,21 +2,30 @@ # List the start up tasks. Learn more: https://www.gitpod.io/docs/configure/workspaces/tasks tasks: + - name: Update FrontMatter CMS Config + command: | + gpUrl=$(gp url 3000);jq --arg gpurl "$gpUrl" '.["frontMatter.preview.host"] = $gpurl' frontmatter.json > tmp.$$.json + mv tmp.$$.json frontmatter.json + gp sync-done frontmatter - name: Tailwind Build and Watch - init: npm install && gp sync-done npm command: | - gp sync-await npm && npx tailwindcss -i ./src/app.css -o ./static/css/main.css && gp sync-done styles + gp sync-await frontmatter + npm install + gp sync-done npm + npx tailwindcss -i ./src/app.css -o ./static/css/main.css + gp sync-done styles npx tailwindcss -i ./src/app.css -o ./static/css/main.css --watch - name: Setup and Run Dev Environment command: | - gp sync-await npm + gp sync-await npm export HMR_HOST=`gp url 5173` export PUBLIC_BUILD_MODE=development git config --global pull.rebase false git config --global fetch.prune true git config --global diff.colorMoved zebra bash scripts/tweego_build.sh - gp sync-await styles && npm run dev --watch + gp sync-await styles + npm run dev --watch # List the ports to expose. Learn more: https://www.gitpod.io/docs/configure/workspaces/ports ports: -- GitLab From 033204d355d7aabe5b62e9c0aa3813561e0a0dc5 Mon Sep 17 00:00:00 2001 From: "Bryan Klein (TECi)" Date: Thu, 15 Aug 2024 16:31:49 +0000 Subject: [PATCH 4/6] Update .gitpod.yml --- .gitpod.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitpod.yml b/.gitpod.yml index eafa9c0..e1e1bf0 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -4,7 +4,7 @@ tasks: - name: Update FrontMatter CMS Config command: | - gpUrl=$(gp url 3000);jq --arg gpurl "$gpUrl" '.["frontMatter.preview.host"] = $gpurl' frontmatter.json > tmp.$$.json + gpUrl=$(gp url 5173);jq --arg gpurl "$gpUrl" '.["frontMatter.preview.host"] = $gpurl' frontmatter.json > tmp.$$.json mv tmp.$$.json frontmatter.json gp sync-done frontmatter - name: Tailwind Build and Watch -- GitLab From 055188130dab48cbf705c7ac7bd239866177176f Mon Sep 17 00:00:00 2001 From: Bryan Klein Date: Thu, 15 Aug 2024 16:34:26 +0000 Subject: [PATCH 5/6] Update Frontmatter Settings. --- .vscode/settings.json | 3 +-- frontmatter.json | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 3d8c4bd..6167305 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,6 +5,5 @@ "workbench.editor.labelFormat": "short", "explorer.compactFolders": false, "workbench.iconTheme": "material-icon-theme", - "workbench.tree.indent": 12, - "frontMatter.dashboard.openOnStart": true + "workbench.tree.indent": 12 } diff --git a/frontmatter.json b/frontmatter.json index c9c87b5..409d4cf 100644 --- a/frontmatter.json +++ b/frontmatter.json @@ -1,6 +1,6 @@ { "$schema": "https://beta.frontmatter.codes/frontmatter.schema.json", - "frontMatter.preview.host": "https://5173-tgdp-www-1rn0oma6mh9.ws-us115.gitpod.io", + "frontMatter.preview.host": "https://5173-tgdp-www-sehjer4aczq.ws-us115.gitpod.io", "frontMatter.framework.id": "other", "frontMatter.framework.startCommand": "npm run dev", "frontMatter.dashboard.openOnStart": true, -- GitLab From 7f9a1ea5ea99ed073de92cd021a7e92ba27a31a8 Mon Sep 17 00:00:00 2001 From: Bryan Klein Date: Thu, 15 Aug 2024 16:51:04 +0000 Subject: [PATCH 6/6] Update frontmatter settings. --- .frontmatter/database/taxonomyDb.json | 2 +- frontmatter.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.frontmatter/database/taxonomyDb.json b/.frontmatter/database/taxonomyDb.json index 726333e..1480742 100644 --- a/.frontmatter/database/taxonomyDb.json +++ b/.frontmatter/database/taxonomyDb.json @@ -1 +1 @@ -{"taxonomy":{"tags":["gitlab","open-source","partnership","writers-block","writing","writing-tips"]}} \ No newline at end of file +{"taxonomy":{"tags":["gitlab","open-source","partnership","style","writers-block","writing","writing-tips"]}} \ No newline at end of file diff --git a/frontmatter.json b/frontmatter.json index 409d4cf..dd5dd0e 100644 --- a/frontmatter.json +++ b/frontmatter.json @@ -1,6 +1,6 @@ { "$schema": "https://beta.frontmatter.codes/frontmatter.schema.json", - "frontMatter.preview.host": "https://5173-tgdp-www-sehjer4aczq.ws-us115.gitpod.io", + "frontMatter.preview.host": "https://5173-tgdp-www-jvim6un7atl.ws-us115.gitpod.io", "frontMatter.framework.id": "other", "frontMatter.framework.startCommand": "npm run dev", "frontMatter.dashboard.openOnStart": true, @@ -375,4 +375,4 @@ } ], "frontMatter.git.enabled": false -} \ No newline at end of file +} -- GitLab