hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-30 18:27:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

Hide Workflow in How to Write Guidelines

Browse Source
This commit is contained in:
marianna.kononenko 2024-05-16 16:28:39 +02:00
parent c3fa5426bb
commit 0da2304bbf
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
topics/ui/resources/how_to_write_guidelines.md
View File

@ -4,16 +4,22 @@
<link-summary>Workflow and basic rules of writing articles for IntelliJ Platform UI Guidelines.</link-summary>
<p>This page describes the workflow and basic rules of writing articles for IntelliJ Platform UI Guidelines.</p>
<p>This page describes the basic rules of writing articles for IntelliJ Platform UI Guidelines.</p>
## Workflow
[//]: # (## Workflow)
Follow these steps if you want to add a new article to the guidelines:
1. Write an article in the Google doc.
2. Share the Google doc with the designers team, so they can review and comment the document.
3. When all comments are resolved, send the Google doc to tech writers for grammar review. [Create ticket](https://youtrack.jetbrains.com/newIssue?project=DOC&clearDraft=true&c=Type+Task&c=Assignee+Anna.Gasparyan&c=Subsystem+IntelliJ+IDEA) in YouTrack project “Documentation”, subsystem “IntelliJ IDEA”, auto-assigned to Anna Gasparyan.
4. After the review, add the article to the guidelines. Follow the instructions on [https://github.com/JetBrains/ui](https://github.com/JetBrains/ui).
4. Contact developers to add Code Snippets to the article.
[//]: # ()
[//]: # (Follow these steps if you want to add a new article to the guidelines:)
[//]: # (1. Write an article in the Google doc.)
[//]: # (2. Share the Google doc with the designers team, so they can review and comment the document.)
[//]: # (3. When all comments are resolved, send the Google doc to tech writers for grammar review. [Create ticket]&#40;https://youtrack.jetbrains.com/newIssue?project=DOC&clearDraft=true&c=Type+Task&c=Assignee+Anna.Gasparyan&c=Subsystem+IntelliJ+IDEA&#41; in YouTrack project “Documentation”, subsystem “IntelliJ IDEA”, auto-assigned to Anna Gasparyan.)
[//]: # (4. After the review, add the article to the guidelines. Follow the instructions on [https://github.com/JetBrains/ui]&#40;https://github.com/JetBrains/ui&#41;.)
[//]: # (4. Contact developers to add Code Snippets to the article.)
## Text