[IGNITE-13526] Ignite Docs: document contribution and release processes

• Type: Task
• Status: Closed
• Priority: Critical
• Resolution: Fixed
• Fix Version/s: 2.9
• Component/s: documentation
• Labels: new-docs
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Denis A. Magda
• Reporter: Denis A. Magda
• Created: 05/Oct/20 22:52
• Updated: 14/Oct/20 22:59
• Resolved: 14/Oct/20 22:59

Description

We need to document the contribution, maintenance, and release processes. Some pointers for the beginning:

• https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document
• https://github.com/apache/ignite/blob/IGNITE-7595/docs/README.adoc
• How to build and test locally before pushing changes (using the ignite repository that stores the docs' sources)
• How to transform the docs into the HTML and deploy on the website:
• How to add a page to the navigation menu
• How to set up redirects if page's URL is changed (seems this has to be done on the website end)

Explain how to create callouts:

[CAUTION]
====
[discrete]
=== Embedded Mode Deprecation
Embedded mode implies starting Ignite server nodes within Spark executors which can cause unexpected rebalancing or even data loss. Therefore this mode is currently deprecated and will be eventually discontinued. Consider starting a separate Ignite cluster and using standalone mode to avoid data consistency and performance issues.
====

[NOTE]
====
[discrete]
=== Embedded Mode Deprecation
Embedded mode implies starting Ignite server nodes within Spark executors which can cause unexpected rebalancing or even data loss. Therefore this mode is currently deprecated and will be eventually discontinued. Consider starting a separate Ignite cluster and using standalone mode to avoid data consistency and performance issues.
====