Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs: Configuration “configuration-options” #6628

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Zearin
Copy link
Contributor

@Zearin Zearin commented Dec 18, 2022

Automatically generated by Netlify CMS

@Zearin Zearin requested a review from a team December 18, 2022 19:15
@Zearin
Copy link
Contributor Author

Zearin commented Dec 18, 2022

(Wow, it really created a PR automatically based on my edits! That is very cool.)

Just learning about this project, and thought I’d try and contribute a few small edits to the docs.

According to the docs style guide, documentation shouldn’t include latin abbreviations (like “e.g.” or “i.e.”), with the sole exception of “etc.”.

Most of this PR is correcting this discrepancy, with a few other small copy-edits as well.

@netlify
Copy link

netlify bot commented Apr 25, 2023

Deploy Preview for decap-www ready!

Name Link
🔨 Latest commit d073b46
🔍 Latest deploy log https://app.netlify.com/sites/decap-www/deploys/6447cd046acfbb00080f9d05
😎 Deploy Preview https://deploy-preview-6628--decap-www.netlify.app/docs/configuration-options
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

It can be disabled by setting the top level `search` property to `false`.

Defaults to `true`
Defaults to `true.`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defaults to true.

@@ -265,14 +266,14 @@ If you have an explicit frontmatter format declared, this option allows you to s

### `slug`

For folder collections where users can create new items, the `slug` option specifies a template for generating new filenames based on a file's creation date and `title` field. (This means that all collections with `create: true` must have a `title` field (a different field can be used via [`identifier_field`](#identifier_field)).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the link

* `{{slug}}` is the entire slug for the current entry (not just the url-safe identifier, as is the case with [`slug` configuration](#slug))
* The date based template tags, such as `{{year}}` and `{{month}}`, are pulled from a date field in your entry, and may require additional configuration - see [`preview_path_date_field`](#preview_path_date_field) for details. If a date template tag is used and no date can be found, `preview_path` will be ignored.
* `{{slug}}` is the entire slug for the current entry (not just the URL-safe identifier, as is the case with [`slug` configuration](#slug))
* The date based template tags (such as `{{year}}` and `{{month}}`) are pulled from a date field in your entry, and may require additional configuration. (See [`preview_path_date_field`](#preview_path_date_field) for details.) If a date template tag is used and no date can be found, `preview_path` will be ignored.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to wrap a sentence into parentheses.

@privatemaker
Copy link
Contributor

@Zearin I can also take this one too, if you'd like!!

@martinjagodic
Copy link
Member

@Zearin @privatemaker I created the new repo at https://github.com/decaporg/decap-website, so this PR would have to be created again on that repo. Sorry for the mess, I kinda missed it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants