-
Notifications
You must be signed in to change notification settings - Fork 449
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
Add YAML metadata guideline #1189
Open
journey2w
wants to merge
1
commit into
Samsung:master
Choose a base branch
from
journey2w:yaml-guideline
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
# YAML metadata in Tizen documentents | ||
|
||
This guideline describes YAML syntax and YAML meta. | ||
|
||
The following code shows the YAML metadata in Tizen documents. | ||
|
||
## Syntax | ||
|
||
All YAML files can optionally begin with `---` and end with `---`. This is part of the YAML format and indicates the start and end of a document. | ||
|
||
|
||
A dictionary is represented in a simple `key: value` form (the colon must be followed by a space): | ||
``` | ||
--- | ||
title: YAML metadata in Tizen documentents | ||
author: Anonymous ([email protected]) | ||
summary: YAML metadata guideline | ||
keyword: YAML, metadata, Tizen, YAML syntax | ||
redirect: overview | ||
--- | ||
``` | ||
|
||
## YAML elements | ||
|
||
The Tizen documentation has various YAML elements. | ||
|
||
### title | ||
|
||
There is no title in menu, the title in meta displays displays this title. | ||
|
||
``` | ||
--- | ||
title: YAML metadata in Tizen documentents | ||
--- | ||
``` | ||
|
||
### author | ||
|
||
The Tizen repository is in public GitHub so we don't know the exact the document authors. | ||
When the authors are listed, it helps to contact the authors when there are issues. | ||
|
||
``` | ||
--- | ||
author: Anonymous ([email protected]) | ||
--- | ||
``` | ||
|
||
### summary | ||
|
||
Summary describes what the document is briefly. | ||
|
||
``` | ||
--- | ||
summary: YAML metadata guideline | ||
--- | ||
``` | ||
|
||
### keyword | ||
|
||
Keywords in the document are extracted automatically when a Pull Request is sent. The extracted keywords are words list. Words are split by a space. In other words, it can't detect collocations with space such as "heavy rain", "high temperature", and "have an experience". | ||
However, you can manually insert keywords at the beginning of documents to improve Search Engine Optimization (SEO). | ||
|
||
``` | ||
--- | ||
keyword: Tizen, guidleline, YAML syntax | ||
--- | ||
``` | ||
In the above example, "YAML syntax" is a kind of collocations. | ||
|
||
### redirect | ||
|
||
Redirect allows the page jump the other page. For example, there is a representative page, which is a root having lots of children. | ||
In general, when there is `index.md` in the root directory, and children in subdirectories. | ||
|
||
For example, Your documents exist in folders as the follows: | ||
``` | ||
root | ||
├── build | ||
│ └── package.md | ||
├── index.md | ||
└── setup | ||
└── overview.md | ||
└── install.md | ||
|
||
``` | ||
|
||
You want to show the overview page, as soon as a user click the root page. In this case, `index.md` has only YAML metadata. | ||
|
||
The following YAML meta can fulfill your requirement. | ||
|
||
``` | ||
--- | ||
redirect: setup/overview | ||
--- | ||
``` | ||
|
||
### | ||
|
||
## Related information | ||
|
||
- [YAML](https://yaml.org/) | ||
- [YAML Syntax](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html) | ||
- [Metadata in Microsoft Word documents](https://blog.martinfenner.org/2015/03/20/metadata-in-microsoft-word-documents/) | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small question. If another person, who is not the author updates or enhances the page, how should we change the author?