未验证 提交 07ddb79d 编写于 作者: Y ymolochkov 提交者: GitHub

IGNITE-13884 Merged docs into 2.9.1 from 2.9 branch with updates (#8598)

* IGNITE-7595: new Ignite docs (returning the original changes after fixing licensing issues)

(cherry picked from commit 073488ac)

* IGNITE-13574: add license headers for some imported files of the Ignite docs (#8361)

* Added a proper license header to some files used by the docs.

* Enabled the defaultLicenseMatcher for the license checker.

(cherry picked from commit d928fb85)

* ignite docs: updated a couple of contribution instructions

(cherry picked from commit 9e8da702)

* IGNITE-13527: replace some references to the readme.io docs with the references to the new pages. The job will be finished as part of IGNITE-13586

(cherry picked from commit 7399ae64)

* ignite docs: fixed broken lings to the SQLLine page

(cherry picked from commit faf4f467)

* IGNITE-13615 Update .NET thin client feature set documentation

* IGNITE-13652 Wrong GitHub link for Apache Ignite With Spring Data/Example (#8420)

* ignite docs: updated the TcpDiscovery.soLinger documentation

* IGNITE-13663 : Represent in the documenttion affection of several node addresses on failure detection v2. (#8424)

* ignite docs: set the latest spring-data artifact id after receiving user feedback

* IGNITE-12951 Update documents for migrated extensions - Fixes #8488.
Signed-off-by: Nsamaitra <saikat.maitra@gmail.com>
(cherry picked from commit 15a5da50)

* ignite docs: fixing a broken documentation link

* ignite docs: updated the index page with quick links to the APIs and examples

* ignite docs: fixed broken links and updated the C++ API header

* ignite docs: fixed case of GitHub

* IGNITE-13876 Updated documentation for 2.9.1 release (#8592)

(cherry picked from commit e74cf6ba)
Co-authored-by: NDenis Magda <dmagda@gridgain.com>
Co-authored-by: NPavel Tupitsyn <ptupitsyn@apache.org>
Co-authored-by: NDenis Garus <garus.d.g@gmail.com>
Co-authored-by: NVladsz83 <vladsz83@gmail.com>
Co-authored-by: Nsamaitra <saikat.maitra@gmail.com>
Co-authored-by: NNikita Safonov <73828260+nikita-tech-writer@users.noreply.github.com>
Co-authored-by: Nymolochkov <ynmolochkov@sberbank.ru>
上级 adcce517
......@@ -36,7 +36,7 @@ Apache Ignite prefer to use [consensus to make decisions](http://community.apach
## Contributing Documentation
Documentation can be contributed to
- End-User documentation https://apacheignite.readme.io/ . Use Suggest Edits. See also [How To Document](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document).
- End-User documentation https://ignite.apache.org/docs/latest/ . Use Suggest Edits. See also [How To Document](https://cwiki.apache.org/confluence/display/IGNITE/How+to+Document).
- Developer documentation, design documents, IEPs [Apache Wiki](https://cwiki.apache.org/confluence/display/IGNITE). Ask at [Dev List](https://lists.apache.org/list.html?dev@ignite.apache.org) to be added as editor.
- Markdown files, visible at GitHub, e.g. README.md; drawings explaining Apache Ignite & product internals.
- Javadocs for packages (package-info.java), classes, methods, etc.
......
......@@ -18,13 +18,7 @@ The main feature set of Ignite includes:
For information on how to get started with Apache Ignite please visit:
http://apacheignite.readme.io/docs/getting-started
You can find Apache Ignite documentation here:
http://apacheignite.readme.io/docs
https://ignite.apache.org/docs/latest/
Crypto Notice
=============
......@@ -49,12 +43,12 @@ and source code.
The following provides more details on the included cryptographic software:
* JDK SSL/TLS libraries used to enable secured connectivity between cluster
nodes (https://apacheignite.readme.io/docs/ssltls).
nodes (https://ignite.apache.org/docs/latest/security/ssl-tls).
Oracle/OpenJDK (https://www.oracle.com/technetwork/java/javase/downloads/index.html)
* JDK Java Cryptography Extensions build in encryption from the Java libraries is used
for Transparent Data Encryption of data on disk
(https://apacheignite.readme.io/docs/transparent-data-encryption)
(https://ignite.apache.org/docs/latest/security/tde)
and for AWS S3 Client Side Encryprion.
(https://java.sun.com/javase/technologies/security/)
......@@ -74,4 +68,4 @@ Eclipse Jetty (http://eclipse.org/jetty)
* Apache Ignite.NET uses .NET Framework crypto APIs from standard class library
for all security and cryptographic related code.
.NET Classic, Windows-only (https://dotnet.microsoft.com/download)
.NET Core (https://dotnetfoundation.org/projects)
\ No newline at end of file
.NET Core (https://dotnetfoundation.org/projects)
......@@ -15,7 +15,7 @@
# ==================================================================
# This is a sample file for Visor CMD to use with "start" command.
# More info: https://apacheignite-tools.readme.io/docs/start-command
# More info: https://ignite.apache.org/docs/latest/tools/visor-cmd
# ==================================================================
# Section with settings for host1:
......
.jekyll-cache/
_site/
Gemfile.lock
.jekyll-metadata
source "https://rubygems.org"
# git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
gem 'asciidoctor'
gem 'jekyll', group: :jekyll_plugins
gem 'wdm', '~> 0.1.1' if Gem.win_platform?
group :jekyll_plugins do
gem 'jekyll-asciidoc'
end
#gem 'pygments.rb', '~> 1.2.1'
gem 'thread_safe', '~> 0.3.6'
gem 'slim', '~> 4.0.1'
gem 'tilt', '~> 2.0.9'
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to You under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
= Apache Ignite Documentation
:toc:
:toc-title:
== Overview
The Apache Ignite documentation is maintained in the repository with the code base, in the "/docs" subdirectory. The directory contains the source files, HTML templates and css styles.
The Apache Ignite documentation is written in link:https://asciidoctor.org/docs/what-is-asciidoc/[asciidoc].
The Asciidoc files are compiled into HTML pages and published to https://ignite.apache.org/docs.
.Content of the “docs” directory
[cols="1,4",opts="stretch"]
|===
| pass:[_]docs | The directory with .adoc files and code-snippets.
| pass:[_]config.yml | Jekyll configuration file.
|===
== Building the Docs Locally
To build the docs locally, you can install `jekyll` and other dependencies on your machine, or you can use Jekyll docker image.
=== Install Jekyll and Asciidoctor
. Install Jekyll by following this instruction: https://jekyllrb.com/docs/installation/[window=_blank]
. In the “/docs” directory, run the following command:
+
[source, shell]
----
$ bundle
----
+
This should install all dependencies, including `asciidoctor`.
. Start jekyll:
+
[source, shell]
----
$ bundle exec jekyll s
----
The command compiles the Asciidoc files into HTML pages and starts a local webserver.
Open `http://localhost:4000/docs[window=_blank]` in your browser.
=== Run with Docker
The following command starts jekyll in a container and downloads all dependencies. Run the command in the “/docs” directory.
[source, shell]
----
$ docker run -v "$PWD:/srv/jekyll" -p 4000:4000 jekyll/jekyll:latest jekyll s
----
Open `http://localhost:4000/docs[window=_blank]` in your browser.
== How to Contribute
If you want to contribute to the documentation, add or modify the relevant page in the `docs/_docs` directory.
This directory contains all .adoc files (which are then rendered into HTML pages and published on the web-site).
Because we use asciidoc for documentation, consider the following points:
* Get familiar with the asciidoc format: https://asciidoctor.org/docs/user-manual/. You don’t have to read the entire manual. Search through it when you want to learn how to create a numbered list, or insert an image, or use italics.
* Please read the link:https://asciidoctor.org/docs/asciidoc-recommended-practices:[AsciiDoc Recommended Practices] and try to adhere to those when editing the .adoc source files.
The following sections explain specific asciidoc syntax that we use.
=== Table of content
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.
Remove the file extension (.adoc).
For example:
[source, adoc]
----
link:persistence/native-persistence[Native Persistence]
----
This is a link to the Native Persistence page.
=== Links to external resources
When referencing an external resource, make the link to open in a new window by adding the `window=_blank` attribute:
[source, adoc]
----
link:https://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html#SunJSSE_Protocols[Supported protocols,window=_blank]
----
=== Tabs
We use custom syntax to insert tabs. Tabs are used to provide code samples for different programming languages.
Tabs are defined by the `tabs` block:
```
[tabs]
--
individual tabs are defined here
--
```
Each tab is defined by the 'tab' directive:
```
tab:tab_name[]
```
where `tab_name` is the title of the tab.
The content of the tab is everything that is given between the tab title, and the next tab or the end of the block.
```asciidoc
[tabs]
--
tab:XML[]
The content of the XML tab goes here
tab:Java[]
The content of the Java tab is here
tab:C#/.NET[]
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).
We use the `include` feature of asciidoc.
Source code files are located in the `docs/_docs/code-snippets/{language}` folders.
To add a code snippet to a page, follow these steps:
* Create a file in the code snippets directory, e.g. _docs/code-snippets/java/org/apache/ignite/snippets/JavaThinClient.java
* Enclose the piece of code you want to include within named tags (see https://asciidoctor.org/docs/user-manual/#by-tagged-regions). Give the tag a self-evident name.
For example:
+
```
[source, java]
----
// tag::clientConnection[]
ClientConfiguration cfg = new ClientConfiguration().setAddresses("127.0.0.1:10800");
try (IgniteClient client = Ignition.startClient(cfg)) {
ClientCache<Integer, String> cache = client.cache("myCache");
// get data from the cache
}
// end::clientConnection[]
----
```
* Include the tag in the adoc file:
+
[source, adoc,subs="macros"]
----
\include::{javaCodeDir}/JavaThinClient.java[tag=clientConnection,indent=0]
----
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
exclude: [guidelines.md, "Gemfile", "Gemfile.lock", README.adoc, "_docs/code-snippets", "_docs/includes", '*.sh']
attrs: &asciidoc_attributes
version: 2.9.1
base_url: /docs
stylesdir: /docs/assets/css
imagesdir: /docs
source-highlighter: rouge
table-stripes: even
javadoc_base_url: https://ignite.apache.org/releases/{version}/javadoc
javaCodeDir: code-snippets/java/src/main/java/org/apache/ignite/snippets
csharpCodeDir: code-snippets/dotnet
githubUrl: https://github.com/apache/ignite/tree/master
docSourceUrl: https://github.com/apache/ignite/tree/IGNITE-7595/docs
collections:
docs:
permalink: /docs/:path:output_ext
output: true
defaults:
-
scope:
path: ''
values:
layout: 'doc'
-
scope:
path: '_docs'
values:
toc: ignite
asciidoctor:
base_dir: _docs/
attributes: *asciidoc_attributes
此差异已折叠。