-
-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: added docs for creating new docs directories and opening a docs… (
#984) Co-authored-by: Quetzalli <[email protected]>%0ACo-authored-by: Quetzalli <[email protected]>
- Loading branch information
1 parent
e55f4bf
commit 45af17e
Showing
2 changed files
with
39 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title : 'Create new docs directories' | ||
weight : 80 | ||
--- | ||
|
||
### Create new docs directories | ||
Create a new docs directory (folder) via the following steps: | ||
1. Identify the content bucket under which your document falls. | ||
2. Open the project locally in your code editor of choice and navigate to the parent folder. | ||
3. Right-click on the parent folder and click "new folder". | ||
4. Give an appropriate name to the new folder. | ||
5. Add the following two files to the new folder: | ||
1. `index.md`: Used as the main content for a website's directory or specific webpage. It's named index because many web servers are configured to automatically look for an index file when accessing a directory. When you access a directory on a web server, if an `index.md` file is present, it will be displayed as the default page for that directory. | ||
2. `_section.md`: Used for reusable components or partial content within a website's structure. It defines the page's `title` and `weight`. The title defines a human-readable title, and weight controls the order in which sections (directories) are displayed. | ||
6. You can edit the index page after successfully creating these pages. | ||
|
||
```mermaid | ||
flowchart LR | ||
A[parent Folder] --> B[new Folder] | ||
B[new Folder] --> C[index.md] | ||
B[new Folder] --> D[_section.md] | ||
B[new Folder] --> E[example-doc-1.md] | ||
B[new Folder] --> F[example-doc-2.md] | ||
``` |
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,15 @@ | ||
--- | ||
title : 'Create new docs pull request' | ||
weight : 90 | ||
--- | ||
|
||
## Create a new docs pull request | ||
Create and submit a docs pull request (PR) via the following steps: | ||
|
||
- A Docs’ PR should solve one documentation problem. | ||
- If there is no current issue for the docs task you want to accomplish, please open a docs issue before creating a PR. | ||
- Use the [conventional commit style](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title. | ||
- Please check your contribution and ensure it follows the AsyncAPI style guide. | ||
- Tag other technical writers to review your document. | ||
- Tag an engineer or subject matter expert (SME) to review the technical details. | ||
- After implementing all the feedback you requested, please update your PR and wait for further feedback before it can be merged. |