diff --git a/website/content/docs/add-to-your-site.md b/website/content/docs/add-to-your-site.md index 3083077e..0380c592 100755 --- a/website/content/docs/add-to-your-site.md +++ b/website/content/docs/add-to-your-site.md @@ -1,7 +1,7 @@ --- +group: Intro +weight: 3 title: Add to Your Site -weight: 20 -group: intro --- You can adapt Netlify CMS to a wide variety of projects. It works with any content written in markdown, JSON, YAML, or TOML files, stored in a repo on [GitHub](https://github.com/), [GitLab](https://about.gitlab.com/), or [Bitbucket](https://bitbucket.org). You can also create your own custom backend. diff --git a/website/content/docs/architecture.md b/website/content/docs/architecture.md index 7255c291..dbeedf35 100755 --- a/website/content/docs/architecture.md +++ b/website/content/docs/architecture.md @@ -1,7 +1,8 @@ --- title: Architecture position: 90 -group: contributing +group: Contributing +weight: 200 --- Netlify CMS is a React application, using Redux for state management with immutable data structures (immutable.js). diff --git a/website/content/docs/backends-overview.md b/website/content/docs/backends-overview.md index 56f1dfb5..2e2f4a5d 100644 --- a/website/content/docs/backends-overview.md +++ b/website/content/docs/backends-overview.md @@ -1,7 +1,7 @@ --- -title: Overview +group: Accounts weight: 1 -group: accounts +title: Overview --- A backend is JavaScript code that allows Netlify CMS to communicate with a service that stores content - typically a Git host like GitHub or GitLab. It provides functions that Netlify CMS can use to do things like read and update files using API's provided by the service. diff --git a/website/content/docs/beta-features.md b/website/content/docs/beta-features.md index 26e4baec..bfd543f3 100644 --- a/website/content/docs/beta-features.md +++ b/website/content/docs/beta-features.md @@ -1,7 +1,7 @@ --- title: Beta Features! weight: 200 -group: configuration +group: Configuration --- We run new functionality in an open beta format from time to time. That means that this functionality is totally available for use, and we _think_ it might be ready for primetime, but it could break or change without notice. diff --git a/website/content/docs/bitbucket-backend.md b/website/content/docs/bitbucket-backend.md index 94bc7cad..26ea8f8e 100644 --- a/website/content/docs/bitbucket-backend.md +++ b/website/content/docs/bitbucket-backend.md @@ -1,7 +1,7 @@ --- -title: Bitbucket +group: Accounts weight: 20 -group: accounts +title: Bitbucket --- For repositories stored on Bitbucket, the `bitbucket` backend allows CMS users to log in directly with their Bitbucket account. Note that all users must have write access to your content repository for this to work. diff --git a/website/content/docs/cloudinary.md b/website/content/docs/cloudinary.md index 6c30fdcb..23fb12a5 100644 --- a/website/content/docs/cloudinary.md +++ b/website/content/docs/cloudinary.md @@ -1,6 +1,6 @@ --- title: Cloudinary -group: media +group: Media weight: 10 --- Cloudinary is a digital asset management platform with a broad feature set, including support for responsive image generation and url based image transformation. They also provide a powerful media library UI for managing assets, and tools for organizing your assets into a hierarchy. diff --git a/website/content/docs/collection-types.md b/website/content/docs/collection-types.md index 7ca9951e..423e50fb 100644 --- a/website/content/docs/collection-types.md +++ b/website/content/docs/collection-types.md @@ -1,8 +1,7 @@ --- title: Collection Types -group: collections -weight: 27 - +group: Collections +weight: 10 --- All editable content types are defined in the `collections` field of your `config.yml` file, and display in the left sidebar of the Content page of the editor UI. diff --git a/website/content/docs/configuration-options.md b/website/content/docs/configuration-options.md index 68c5813c..67b61dde 100644 --- a/website/content/docs/configuration-options.md +++ b/website/content/docs/configuration-options.md @@ -1,7 +1,7 @@ --- title: Configuration Options -group: configuration -weight: 23 +group: Configuration +weight: 10 --- ## Configuration File diff --git a/website/content/docs/contributor-guide.md b/website/content/docs/contributor-guide.md index 4bd42a38..c7fa6737 100644 --- a/website/content/docs/contributor-guide.md +++ b/website/content/docs/contributor-guide.md @@ -1,7 +1,7 @@ --- title: Contributor Guide weight: 20 -group: contributing +group: Contributing --- We're hoping that Netlify CMS will do for the [JAMstack](https://www.jamstack.org) what WordPress did for dynamic sites back in the day. We know we can't do that without building a thriving community of contributors and users, and we'd love to have you join us. diff --git a/website/content/docs/custom-widgets.md b/website/content/docs/custom-widgets.md index 5c17cc5c..2b7641cd 100644 --- a/website/content/docs/custom-widgets.md +++ b/website/content/docs/custom-widgets.md @@ -1,7 +1,7 @@ --- title: Creating Custom Widgets -group: fields -weight: 35 +group: Fields +weight: 20 --- The NetlifyCMS exposes a `window.CMS` a global object that you can use to register custom widgets, previews, and editor plugins. The same object is also the default export if you import Netlify CMS as an npm module. The available widget extension methods are: diff --git a/website/content/docs/customization.md b/website/content/docs/customization.md index eec087c4..e38ae6a6 100644 --- a/website/content/docs/customization.md +++ b/website/content/docs/customization.md @@ -1,7 +1,7 @@ --- title: Creating Custom Previews weight: 50 -group: customization +group: Customization --- The NetlifyCMS exposes a `window.CMS` global object that you can use to register custom widgets, previews and editor plugins. The available customization methods are: diff --git a/website/content/docs/deploy-preview-links.md b/website/content/docs/deploy-preview-links.md index 2784e026..3e522fed 100644 --- a/website/content/docs/deploy-preview-links.md +++ b/website/content/docs/deploy-preview-links.md @@ -1,7 +1,7 @@ --- -title: Deploy Preview Links -group: workflow +group: Workflow weight: 10 +title: Deploy Preview Links --- When using the editorial workflow, content editors can create and save content without publishing it to a live site. Deploy preview links provide a way to view live content when it has not been diff --git a/website/content/docs/examples.md b/website/content/docs/examples.md index 3982be3c..240039f8 100644 --- a/website/content/docs/examples.md +++ b/website/content/docs/examples.md @@ -1,6 +1,6 @@ --- title: Examples -group: contributing +group: Contributing weight: 110 --- diff --git a/website/content/docs/external-oauth-clients.md b/website/content/docs/external-oauth-clients.md index d07ca64f..7e3c3ee8 100644 --- a/website/content/docs/external-oauth-clients.md +++ b/website/content/docs/external-oauth-clients.md @@ -1,7 +1,7 @@ --- title: External OAuth Clients -weight: 40 -group: accounts +group: Accounts +weight: 60 --- If you would like to facilitate your own OAuth authentication rather than use Netlify's service or implicit grant, you can use one of the community-maintained projects below. Feel free to hit the "Edit this page" button if you'd like to add yours! diff --git a/website/content/docs/gatsby.md b/website/content/docs/gatsby.md index b01a1fda..2ddd34fd 100644 --- a/website/content/docs/gatsby.md +++ b/website/content/docs/gatsby.md @@ -1,7 +1,7 @@ --- title: Gatsby -group: guides -weight: 20 +group: Guides +weight: 10 --- This guide will help you get started using Netlify CMS and Gatsby. diff --git a/website/content/docs/git-gateway-backend.md b/website/content/docs/git-gateway-backend.md index aee3f583..2807fad8 100644 --- a/website/content/docs/git-gateway-backend.md +++ b/website/content/docs/git-gateway-backend.md @@ -1,7 +1,7 @@ --- title: Git Gateway weight: 10 -group: accounts +group: Accounts --- [Git Gateway](https://github.com/netlify/git-gateway) is a Netlify open source project that allows you to add editors to your site CMS without giving them direct write access to your GitHub or GitLab repository. (For Bitbucket repositories, use the [Bitbucket backend](#bitbucket-backend) instead.) diff --git a/website/content/docs/github-backend.md b/website/content/docs/github-backend.md index e44b52e8..e1b16787 100644 --- a/website/content/docs/github-backend.md +++ b/website/content/docs/github-backend.md @@ -1,7 +1,7 @@ --- title: GitHub -weight: 20 -group: accounts +group: Accounts +weight: 30 --- For repositories stored on GitHub, the `github` backend allows CMS users to log in directly with their GitHub account. Note that all users must have push access to your content repository for this to work. diff --git a/website/content/docs/gitlab-backend.md b/website/content/docs/gitlab-backend.md index 6eff9a9c..087bd9d6 100644 --- a/website/content/docs/gitlab-backend.md +++ b/website/content/docs/gitlab-backend.md @@ -1,7 +1,7 @@ --- title: GitLab -weight: 20 -group: accounts +group: Accounts +weight: 40 --- For repositories stored on GitLab, the `gitlab` backend allows CMS users to log in directly with their GitLab account. Note that all users must have push access to your content repository for this to work. diff --git a/website/content/docs/hugo.md b/website/content/docs/hugo.md index 26cf7501..daf85f96 100644 --- a/website/content/docs/hugo.md +++ b/website/content/docs/hugo.md @@ -1,6 +1,6 @@ --- title: Hugo -group: guides +group: Guides weight: 20 --- ## Introduction diff --git a/website/content/docs/intro.md b/website/content/docs/intro.md index ec1d6d7e..039aebfe 100755 --- a/website/content/docs/intro.md +++ b/website/content/docs/intro.md @@ -1,7 +1,7 @@ --- title: Overview +group: Intro weight: 1 -group: intro --- Netlify CMS is an open source content management system for your Git workflow that enables you to provide editors with a friendly UI and intuitive workflows. You can use it with any static site generator to create faster, more flexible web projects. Content is stored in your Git repository alongside your code for easier versioning, multi-channel publishing, and the option to handle content updates directly in Git. diff --git a/website/content/docs/jekyll.md b/website/content/docs/jekyll.md index 73a488c6..55218bac 100644 --- a/website/content/docs/jekyll.md +++ b/website/content/docs/jekyll.md @@ -1,7 +1,7 @@ --- title: Jekyll -group: guides -weight: 20 +group: Guides +weight: 30 --- ## Introduction diff --git a/website/content/docs/middleman.md b/website/content/docs/middleman.md index a5268b5d..4e891470 100644 --- a/website/content/docs/middleman.md +++ b/website/content/docs/middleman.md @@ -1,7 +1,7 @@ --- title: Middleman -group: guides -weight: 30 +group: Guides +weight: 60 --- This guide will help you get started using Netlify CMS and Middleman. diff --git a/website/content/docs/netlify-large-media.md b/website/content/docs/netlify-large-media.md index 1687336b..7decf047 100644 --- a/website/content/docs/netlify-large-media.md +++ b/website/content/docs/netlify-large-media.md @@ -1,7 +1,7 @@ --- title: Netlify Large Media -group: media -weight: 10 +group: Media +weight: 20 --- [Netlify Large Media](https://www.netlify.com/features/large-media/) is a [Git LFS](https://git-lfs.github.com/) implementation for repositories connected to Netlify sites. This means that you can use Git to work with large asset files like images, audio, and video, without bloating your repository. It does this by replacing the asset files in your repository with text pointer files, then uploading the assets to the Netlify Large Media storage service. diff --git a/website/content/docs/nextjs.md b/website/content/docs/nextjs.md index 42a11d2a..1dad6798 100644 --- a/website/content/docs/nextjs.md +++ b/website/content/docs/nextjs.md @@ -1,7 +1,7 @@ --- title: NextJS -group: guides -weight: 20 +group: Guides +weight: 40 --- This guide will help you get started using Netlify CMS with NextJS. diff --git a/website/content/docs/nuxt.md b/website/content/docs/nuxt.md index 2005b632..6b41358b 100644 --- a/website/content/docs/nuxt.md +++ b/website/content/docs/nuxt.md @@ -1,7 +1,7 @@ --- title: Nuxt -group: guides -weight: 20 +group: Guides +weight: 50 --- This guide will walk you through how to integrate Netlify CMS with Nuxt. diff --git a/website/content/docs/open-authoring.md b/website/content/docs/open-authoring.md index 8587bf52..74b3f17a 100644 --- a/website/content/docs/open-authoring.md +++ b/website/content/docs/open-authoring.md @@ -1,6 +1,7 @@ --- title: Open Authoring -group: workflow +group: Workflow +weight: 20 --- **This is a [beta feature](/docs/beta-features#open-authoring).** diff --git a/website/content/docs/releases.md b/website/content/docs/releases.md index d011c761..35528880 100644 --- a/website/content/docs/releases.md +++ b/website/content/docs/releases.md @@ -1,7 +1,7 @@ --- title: Releases -weight: 60 -group: intro +group: Intro +weight: 4 --- diff --git a/website/content/docs/start-with-a-template.md b/website/content/docs/start-with-a-template.md index dc5a55f1..752ff093 100644 --- a/website/content/docs/start-with-a-template.md +++ b/website/content/docs/start-with-a-template.md @@ -1,7 +1,7 @@ --- +group: Intro +weight: 2 title: Start with a Template -group: intro -weight: 10 --- You can add Netlify CMS [to an existing site](/docs/add-to-your-site/), but the quickest way to get started is with a template. Found below, our featured templates deploy a bare-bones site and Netlify CMS to Netlify ([what's the difference, you ask?](../intro/#netlify-cms-vs-netlify)), giving you a fully working CMS-enabled site with just a few clicks. diff --git a/website/content/docs/test-backend.md b/website/content/docs/test-backend.md index 6c03ced4..fdb9b077 100644 --- a/website/content/docs/test-backend.md +++ b/website/content/docs/test-backend.md @@ -1,8 +1,7 @@ --- title: Test -weight: 30 -group: accounts - +group: Accounts +weight: 50 --- You can use the `test-repo` backend to try out Netlify CMS without connecting to a Git repo. With this backend, you can write and publish content normally, but any changes will disappear when you reload the page. This backend powers the Netlify CMS [demo site](https://cms-demo.netlify.com/). diff --git a/website/content/docs/uploadcare.md b/website/content/docs/uploadcare.md index 9ee1e96e..79d8dde3 100644 --- a/website/content/docs/uploadcare.md +++ b/website/content/docs/uploadcare.md @@ -1,7 +1,7 @@ --- title: Uploadcare -group: media -weight: 10 +group: Media +weight: 30 --- Uploadcare is a sleek service that allows you to upload files without worrying about maintaining a growing collection — more of an asset store than a library. Just upload when you need to, and the files are hosted on their CDN. They provide image processing controls from simple cropping and rotation to filters and face detection, and a lot more. You can check out Uploadcare's full feature set on their [website](https://uploadcare.com/). diff --git a/website/content/docs/widgets.md b/website/content/docs/widgets.md index d7773b8d..c63a24ee 100644 --- a/website/content/docs/widgets.md +++ b/website/content/docs/widgets.md @@ -1,7 +1,7 @@ --- title: Widgets -weight: 30 -group: fields +group: Fields +weight: 10 --- Widgets define the data type and interface for entry fields. Netlify CMS comes with several built-in widgets. Click the widget names in the sidebar to jump to specific widget details. We’re always adding new widgets, and you can also [create your own](../custom-widgets)! diff --git a/website/content/docs/writing-style-guide.md b/website/content/docs/writing-style-guide.md index 5c36fb6e..b6c308c7 100644 --- a/website/content/docs/writing-style-guide.md +++ b/website/content/docs/writing-style-guide.md @@ -1,7 +1,7 @@ --- title: Writing Style Guide weight: 30 -group: contributing +group: Contributing --- # Netlify CMS Style Guide diff --git a/website/site.yml b/website/site.yml index 4244cdc2..b8177f56 100644 --- a/website/site.yml +++ b/website/site.yml @@ -1,22 +1,22 @@ menu: docs: - - name: intro + - name: Intro title: Intro to Netlify CMS - - name: accounts + - name: Accounts title: Account Settings - - name: configuration + - name: Configuration title: Configuring your Site - - name: media + - name: Media title: Media - - name: workflow + - name: Workflow title: Workflow - - name: collections + - name: Collections title: Collections - - name: fields + - name: Fields title: Fields - - name: guides + - name: Guides title: Platform Guides - - name: customization + - name: Customization title: Customizing Netlify CMS - - name: contributing + - name: Contributing title: Community diff --git a/website/static/admin/config.yml b/website/static/admin/config.yml index 65ffdb04..745f26b7 100644 --- a/website/static/admin/config.yml +++ b/website/static/admin/config.yml @@ -16,79 +16,104 @@ public_folder: /img docs_collection: &docs_collection folder: website/content/docs create: true + summary: '{{weight}} - {{title}}' preview_path: 'docs/{{slug}}' + sortableFields: ['weight', 'title', 'group'] fields: + - label: Section + name: group + widget: relation + collection: settings + file: docs_sections + searchFields: ["menu.docs.*.name", "menu.docs.*.title"] + displayFields: ["menu.docs.*.title"] + valueField: "menu.docs.*.name" + - { label: 'Order', name: weight, widget: number } - { label: Title, name: title } - - { - label: Group, - name: group, - widget: select, - options: [start, backends, features, reference, media, guides, customization, contributing], - } - - { label: Weight, name: weight, widget: number } - { label: Body, name: body, widget: markdown } collections: + - label: Settings + name: settings + hide: true + files: + - label: Docs Sections + name: docs_sections + file: website/site.yml + fields: + - label: menu + name: menu + widget: object + fields: + - label: Sections + label_singular: Section + name: docs + widget: list + summary: '{{title}} ({{name}})' + fields: + - { label: 'Full Name', name: 'title', widget: 'string' } + - { label: 'Summary Name', name: 'name', widget: 'string' } + - <<: *docs_collection name: docs_intro label: 'Docs: Intro' filter: field: group - value: intro + value: Intro - <<: *docs_collection name: docs_accounts label: 'Docs: Account' filter: field: group - value: accounts + value: Accounts - <<: *docs_collection name: docs_configuration label: 'Docs: Configuration' filter: field: group - value: configuration + value: Configuration - <<: *docs_collection name: docs_media label: 'Docs: Media' filter: field: group - value: media + value: Media - <<: *docs_collection name: docs_workflow label: 'Docs: Workflow' filter: field: group - value: workflow + value: Workflow - <<: *docs_collection name: docs_collections label: 'Docs: Collections' filter: field: group - value: collections + value: Collections - <<: *docs_collection name: docs_fields label: 'Docs: Fields' filter: field: group - value: fields + value: Fields - <<: *docs_collection name: docs_guides label: 'Docs: Guides' filter: field: group - value: guides + value: Guides - <<: *docs_collection name: docs_customization label: 'Docs: Customization' filter: field: group - value: customization + value: Customization - <<: *docs_collection name: docs_contributing label: 'Docs: Contributing' filter: field: group - value: contributing + value: Contributing - name: widget_docs label: 'Docs: Widgets' folder: website/content/docs/widgets