This is an automated email from the ASF dual-hosted git repository.
dmagda pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 9e8da70 ignite docs: updated a couple of contribution instructions
9e8da70 is described below
commit 9e8da702068b1232789f8f9f93680f2c6d69ed16
Author: Denis Magda <dma...@gridgain.com>
AuthorDate: Wed Oct 14 16:09:17 2020 -0700
ignite docs: updated a couple of contribution instructions
---
docs/README.adoc | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/docs/README.adoc b/docs/README.adoc
index 3f13302..856b993 100644
--- a/docs/README.adoc
+++ b/docs/README.adoc
@@ -86,6 +86,14 @@ The following sections explain specific asciidoc syntax that
we use.
The table of content is defined in the `_data/toc.yaml` file.
If you want to add a new page, make sure to update the TOC.
+=== Changing an URL of an existing page
+
+If you rename an already published page or change the page's path in the
`/_data/toc.yaml` file,
+you must configure a proper redirect from the old to the new URL in the
following files of the Ignite website:
+https://github.com/apache/ignite-website/blob/master/.htaccess
+
+Reach out to documentation maintainers if you need any help with this.
+
=== Links to other sections in the docs
All .adoc files are located in the "docs/_docs" directory.
Any link to the files within the directory must be relative to that directory.
@@ -149,6 +157,26 @@ tab:C++[unsupported]
--
```
+=== Callouts
+
+Use the syntax below if you need to bring reader's attention to some details:
+
+[NOTE]
+====
+[discrete]
+=== Callout Title
+Callout Text
+====
+
+Change the callout type to `CAUTION` if you want to put out a warning:
+
+[CAUTION]
+====
+[discrete]
+=== Callout Title
+Callout Text
+====
+
=== Code Snippets
Code snippets must be taken from a compilable source code file (e.g. java, cs,
js, etc).
