[site] howto for migrating docs added

This commit is contained in:
Anna Bulenkova 2015-02-25 11:09:16 +01:00
parent 1ed2c37ed9
commit a6b6b002e9

20
HOWTO.md Normal file
View File

@ -0,0 +1,20 @@
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.
```
<!--
INITIAL_SOURCE https://confluence.jetbrains.com/display/IDEADEV/Build+Number+Ranges
-->
```
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.
Thanks.