Skip to content

Commit e7cc212

Browse files
committed
Add redirect
1 parent 5574cf8 commit e7cc212

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

source/developers/website.markdown

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ Content...Written in markdown.
6363

6464
There are [pre-definied variables](https://jekyllrb.com/docs/variables/) available but usually, it's not necessary to use them when writing documentation.
6565

66+
A couple of points to remember:
67+
68+
- Document the needed steps to retrieve API keys or access token for the third party service or device if needed.
69+
- Keep the configuration sample minimal by only adding the `Required` options. Full configuration details with further explanations should go into a seperate section.
70+
- The description of all the configuration variables should contains information about the used defaults.
71+
6672
### {% linkable_title Embedding Code %}
6773

6874
You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in \`. For multi-line, syntax wrap your code as shown below.
@@ -94,6 +100,16 @@ The direct usage of HTML is supported but not recommended. The note boxes are an
94100
</p>
95101
```
96102

103+
### {% linkable_title Redirects %}
104+
If you rename or move an existing platform or component, create the redirect. Add the old location of the page to the header of the new one.
105+
106+
```test
107+
---
108+
...
109+
redirect_from: /getting-started/android/
110+
---
111+
```
112+
97113
### {% linkable_title Images, icons, and logos %}
98114

99115
The images which are displayed on the pages are stored in various directories according to their purpose.

0 commit comments

Comments
 (0)