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

[Doc engine] Migration rules updated

Browse Source
This commit is contained in:
Anna Bulenkova 2015-03-03 10:36:13 +01:00
parent 80d8a698e0
commit 3f7c64434e
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
HOWTO.md
View File

@ -1,8 +1,9 @@
Rules for migrating documents from other sources
====
If you migrate any documents from other sources to IntelliJ Doc Engine,
please mark initial source with INITIAL_SOURCE tag like the following sample shows.
#Tracking content source
If you migrate any documents from other sources (e.g. Confluence of Development Forum) to IntelliJ Doc Engine,
please mark the newly created Markdown file with INITIAL_SOURCE tag like the following sample shows.
```
<!--
@ -10,11 +11,16 @@ INITIAL_SOURCE https://confluence.jetbrains.com/display/IDEADEV/Build+Number+Ran
-->
```
#TODOs and issues under development
Any issues in a document needed to be re-worked, extended, and\/or newly written should be marked with.
```
<!--TODO Provide detailed description here-->
```
Please make it **case sensitive**.
These tags are required for future testing.
#Tracking old already processed content
If you've migrated a document from confluence, this document should be marked with <migrated> tag.
Please make all the tags **case sensitive**.
These tags are required for future coverage and consistency testing.
Thanks.