Updates CMS pages

utilities/docs/src/components/navigation/config.ts

@@ -213,6 +213,13 @@ export const MAIN_NAVIGATION: MainNavigationConfig = [
         },
         title: 'Get started',
       },
+      {
+        id: '/cms/editing-content',
+        linkProps: {
+          to: '/cms/editing-content',
+        },
+        title: 'Editing content',
+      },
     ],
   },
 ];

utilities/docs/src/content/pages/cms.editing-content.json

@@ -0,0 +1,67 @@
+{
+  "_layout": "basic",
+  "_path": "/cms/editing-content",
+  "title": "Editing content",
+  "leading": "The editorial process in Blueprints CMS: create, fine tune, and publish content.",
+  "content": [
+    {
+      "contentComponentId": "blocks.sidenote",
+      "variant": "warning",
+      "markdown": {
+        "raw": "**Blueprints CMS is currently in alpha. It is only available for a small team of internal testers. If you would like to help us test and improve the CMS (and be one of the first ones to get your hands on it), please reach out to our team.**"
+      }
+    },
+    {
+      "as": "h2",
+      "size": "title",
+      "contentComponentId": "blocks.heading",
+      "title": "Overview",
+      "leading": "Blueprints content management is based on concepts of live version and drafts. It means that there is the live version of content that is currently published and there are drafts to edit the live version. The editorial process starts with creating a new draft, then submitting it for review and finally publishing.",
+      "withCopyLink": false,
+      "withDivider": false
+    },
+    {
+      "contentComponentId": "blocks.text",
+      "markdown": {
+        "raw": "1. **Create a new draft.** To start making changes to the content, you need to create a draft and submit it for review\n\n1. **Edit content.** You can edit as many files as you need in one draft: create new, make changes, delete.\n\n1. **Submit your draft for review.** Once you are ready to share your draft, you can now submit the changes for review. You can still make more changes! This opens a pull request in your GitHub repository to merge the edits you’ve made into the live version.\n\n1. **Merge and publish!** This process takes place outside of Blueprints CMS—in GitHub—and is defined by your development infrastructure and practices. Once your draft is merged into the live version, it should be available on the site or as dictated by your publishing strategy."
+      }
+    },
+    {
+      "as": "h3",
+      "size": "headline",
+      "contentComponentId": "blocks.heading",
+      "title": "In technical terms",
+      "withCopyLink": false,
+      "withDivider": false
+    },
+    {
+      "contentComponentId": "blocks.text",
+      "markdown": {
+        "raw": "Blueprints CMS is a Git and GitHub based system. Your live content is the content on the default or main branch of your repository. Each draft creates a new branch off the default branch. Submitting a draft for review opens a pull request."
+      }
+    },
+    {
+      "as": "h2",
+      "size": "title",
+      "contentComponentId": "blocks.heading",
+      "title": "Collection and unique documents",
+      "withCopyLink": false,
+      "withDivider": true
+    },
+    {
+      "contentComponentId": "blocks.text",
+      "markdown": {
+        "raw": "Blueprints CMS has two document types: collection and unique. The difference is simple, collection documents are part of one collection and follow the same template. Unique documents are one of a kind and don’t have a template."
+      }
+    },
+    {
+      "contentComponentId": "lists.table-list",
+      "variant": "borderless",
+      "data": [
+        ["**Collection**", "Document is a part of a collection, and follows a template. For example, if you have component documentation, your component pages are a collection of documents that follow the same template."],
+        ["**Unique**", "Document is one of a kind, and has no template. Content for pages like home, about us, principles, etc. are unique and one of a kind. They do not have a template shared with any other page on the site."]
+      ],
+      "columnSizing": [1, 4]
+    }
+  ]
+}

utilities/docs/src/content/pages/cms.get-started.json

@@ -15,56 +15,85 @@
       "as": "h2",
       "size": "title",
       "contentComponentId": "blocks.heading",
-      "title": "Starting a new site",
+      "title": "Overview",
+      "leading": "Blueprints CMS edits content files directly in a repository, either alongside your codebase or in a dedicated documentation site repository. There is no database or server for you to set up or run. Blueprints CMS installs as a GitHub app into your repository, after which you can create, edit and publish content.",
+      "withCopyLink": false,
+      "withDivider": false
+    },
+    {
+      "contentComponentId": "blocks.sidenote",
+      "variant": "info",
+      "markdown": {
+        "raw": "All content files and assets are added under a predefined directory at the root of your repository. By default, it is `.blueprints-cms/`. You can configure the CMS directory in `blueprints-cms.config.json`."
+      }
+    },
+    {
+      "as": "h2",
+      "size": "title",
+      "contentComponentId": "blocks.heading",
+      "title": "Get your repository ready",
       "withCopyLink": false,
       "withDivider": false
     },
     {
       "contentComponentId": "blocks.text",
       "markdown": {
-        "raw": "If you don’t have a documentation site yet, but want to build one with Blueprints—this guide is for you. First things first, make sure you have the following ready:\n- Your documentation site repository (in GitHub or Github Enterprise) and admin access to it.\n- Information architecture for your documentation site, even if it is a working draft.\n- Hosting service for your documentation site (e.g. [Azure Static Web App service](https://azure.microsoft.com/en-us/products/app-service/static))."
+        "raw": "First, you need to figure out into which GitHub repository to install the CMS. By installing the CMS, you are adding its configuration and content files. That means the repository you choose will include your content and assets like images and videos. In most cases, you should install the CMS to the repository where you have the rest of your documentation site."
       }
     },
     {
-      "as": "h3",
-      "size": "headline",
+      "contentComponentId": "blocks.sidenote",
+      "variant": "info",
+      "markdown": {
+        "raw": "If you don’t have a documentation site yet, try one of the [Blueprints starters](/starters/introduction/) to get started."
+      }
+    },
+    {
+      "contentComponentId": "blocks.text",
+      "markdown": {
+        "raw": "You can choose a personal public, private, or organization repository. The repository should be in Github or Github Enterprise. Make sure you have the required permissions:\n\n1. Open, review and merge pull requests\n\n2. Read and write the codebase.\n\n If you don’t have the right permission or not sure, ask the repository owner for help."
+      }
+    },
+    {
+      "as": "h2",
+      "size": "title",
       "contentComponentId": "blocks.heading",
-      "title": "Add a starter",
+      "title": "Install the GitHub app",
       "withCopyLink": false,
       "withDivider": false
     },
     {
       "contentComponentId": "blocks.text",
       "markdown": {
-        "raw": "You don’t have to start from zero. Blueprints offer blank documentation site setup ready for your content—**starters**. Clone a [starter](/starters/introduction) into your repository. Talk to our team if you don’t know which starter would work best for your project."
+        "raw": "Once, you have the repository and all the necessary permissions, install the [Blueprints CMS GitHub app](https://github.com/apps/blueprints-cms-test)\n\n- Which account do you want to use (in case if you have multiple)?\n\n- Which organization (if any) do you want to install the app into?\n\n- Do you want to enable the app for the entire organization? Or just select repositories?\n\n**Note**, if you are installing the app into an organization, your admin might need to approve the app. In that case, you will see a request option."
       }
     },
     {
-      "as": "h3",
-      "size": "headline",
+      "as": "h2",
+      "size": "title",
       "contentComponentId": "blocks.heading",
-      "title": "Connect the CMS",
+      "title": "Get the CMS app",
       "withCopyLink": false,
       "withDivider": false
     },
     {
       "contentComponentId": "blocks.text",
       "markdown": {
-        "raw": "Once you have a starter in your repository, you can add Blueprints CMS to it. The CMS is installed as a Github App."
+        "raw": "Great! Now that you have the GitHub app installed it is time to head over to the CMS app. Log in with the same GitHub account as the one you used to install the app.\n\nIn the projects dashboard, chose to add a new project. You should see the list of enabled repositories now, ready for content. Add content management—it should open a pull request in your repository that adds the configuration file and the directory for all your content files and assets. We have added a couple for demo documents for you to get started with.\n\nReview and merge the PR, and head back to the CMS app."
       }
     },
     {
       "as": "h2",
       "size": "title",
       "contentComponentId": "blocks.heading",
-      "title": "Add the CMS to an excising site",
+      "title": "Finish line",
       "withCopyLink": false,
-      "withDivider": true
+      "withDivider": false
     },
     {
       "contentComponentId": "blocks.text",
       "markdown": {
-        "raw": "If you have an established documentation site and want to add Blueprints CMS to it, follow these steps:\n1. **Get admin rights** for your existing site repository (needs to be in Github or Github Enterprise). \n2. **Install the CMS** to your documentation site repository. The CMS is installed as a Github App.\n3. **Migrate your content** to the CMS. You can do this manually or with the help of our team. Please, reach out about your migration needs: we might be able to help you automate the process."
+        "raw": "After the configuration files have been added, you should now see your new project in the dashboard. Now, you are ready to edit and publish content!"
       }
     }
   ]

utilities/docs/src/content/pages/cms.introduction.json

@@ -20,18 +20,17 @@
       "size": "title",
       "contentComponentId": "blocks.heading",
       "title": "About",
-      "withCopyLink": false,
-      "withDivider": false
+      "leading": "Blueprints CMS is a content management system for your documentation site. Our goal is to create a simple, quick to install system to lower the barrier for contributors to write and publish documentation."
     },
     {
       "contentComponentId": "blocks.text",
       "markdown": {
-        "raw": "Blueprints CMS is a content management system that sits in the same codebase as your documentation site. It is a minimal solution to quickly get your editors access to edit and publish new content.\n\n- Integrates with Blueprints UI that content editors can use as building blocks for their content.\n- Offers templates to help wring great documentation.\n- Adds version control and collaborative features."
+        "raw": "- **Minimal & quick to install.** Blueprints CMS doesn’t require a database or server to run. It edits content files directly in a repository, either alongside your codebase or in a dedicated documentation site repository. Blueprints CMS installs as a GitHub app into your repository, after which you can create, edit and publish content.\n\n- **Lowers the barriers.** Provides non-technical authors a way to directly contribute the content and assets to the repository.\n\n- **Designed for documentation.** Blueprints CMS is designed for writing documentation."
       }
     },
     {
       "contentComponentId": "tiles.bookmark-tile",
-      "to": "cms/get-started",
+      "to": "/cms/get-started",
       "title": "Get started",
       "isExternal": false,
       "description": "Guide to adding content management to your documentation site."