Skip to content

Commit

Permalink
IGNITE-13527: replace some references to the readme.io docs with the …
Browse files Browse the repository at this point in the history
…references to the new pages. The job will be finished as part of IGNITE-13586
  • Loading branch information
Denis Magda committed Oct 15, 2020
1 parent 16ffea7 commit 7399ae6
Show file tree
Hide file tree
Showing 10 changed files with 10 additions and 23 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 4 additions & 10 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
=============
Expand All @@ -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/)

Expand All @@ -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)
.NET Core (https://dotnetfoundation.org/projects)
2 changes: 1 addition & 1 deletion config/visor-cmd/node_startup_by_ssh.sample.ini
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ tab:XML[]
<!--
Ignite provides several options for automatic discovery that can be used
instead os static IP based discovery. For information on all options refer
to our documentation: http://apacheignite.readme.io/docs/cluster-config
to our documentation: https://ignite.apache.org/docs/latest/clustering/clustering
-->
<!-- Uncomment static IP finder to enable static-based discovery of initial nodes. -->
<!--<bean class="org.apache.ignite.spi.discovery.tcp.ipfinder.vm.TcpDiscoveryVmIpFinder">-->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ $ {command} logs ignite-cluster-5b69557db6-lcglw -n ignite
[14:34:01] ^-- Specify JVM heap max size (add '-Xmx<size>[g|G|m|M|k|K]' to JVM options)
[14:34:01] ^-- Set max direct memory size if getting 'OOME: Direct buffer memory' (add '-XX:MaxDirectMemorySize=<size>[g|G|m|M|k|K]' to JVM options)
[14:34:01] ^-- Disable processing of calls to System.gc() (add '-XX:+DisableExplicitGC' to JVM options)
[14:34:01] Refer to this page for more performance suggestions: https://apacheignite.readme.io/docs/jvm-and-system-tuning
[14:34:01] Refer to this page for more performance suggestions: https://ignite.apache.org/docs/latest/perf-and-troubleshooting/general-perf-tips
[14:34:01]
[14:34:01] To start Console Management & Monitoring run ignitevisorcmd.{sh|bat}
[14:34:01] Data Regions Configured:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A thin client is a lightweight Ignite client that connects to the cluster via a
It does not become a part of the cluster topology, never holds any data, and is not used as a destination for compute grid calculations.
What it does is simply establish a socket connection to a standard Ignite node and perform all operations through that node.

Thin clients are based on the link:https://apacheignite.readme.io/docs/binary-client-protocol[binary client protocol], which makes it possible to support Ignite connectivity from any programming language.
Thin clients are based on the link:binary-client-protocol/binary-client-protocol[binary client protocol], which makes it possible to support Ignite connectivity from any programming language.

Ignite provides the following thin clients:

Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Instructions on how to start examples can be found in [README.txt](README.txt).
How to start examples in the developer's environment, please see [DEVNOTES.txt](DEVNOTES.txt).

## Running examples on JDK 9/10/11
Ignite uses proprietary SDK APIs that are not available by default. See also [How to run Ignite on JDK 9,10 and 11](https://apacheignite.readme.io/docs/getting-started#section-running-ignite-with-java-9-10-11)
Ignite uses proprietary SDK APIs that are not available by default. See also [How to run Ignite on JDK 9,10 and 11](https://ignite.apache.org/docs/latest/setup#running-ignite-with-java-11-or-later)

To set up local IDE to easier access to examples, it is possible to add following options as default for all applications

Expand Down
3 changes: 0 additions & 3 deletions examples/config/servlet/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,3 @@ Servlet Configuration Example

This folder contains web.xml file that demonstrates how to configure any servlet container
to start a Apache Ignite node inside a Web application.

For more information on available configuration properties, etc. refer to our documentation:
http://apacheignite.readme.io/docs/web-session-clustering
2 changes: 0 additions & 2 deletions examples/redis/redis-example.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
/**
* To execute this script, run an Ignite instance with 'redis-ignite-internal-cache-0' cache specified and configured.
* You will also need to have Predis extension installed. See https://github.com/nrk/predis for Predis details.
*
* See https://apacheignite.readme.io/docs/redis for more details on Redis integration.
*/

// Load the library.
Expand Down
2 changes: 0 additions & 2 deletions examples/redis/redis-example.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@
To execute this script, run an Ignite instance with 'redis-ignite-internal-cache-0' cache specified and configured.
You will also need to have 'redis-py' installed.
See https://github.com/andymccurdy/redis-py for the details on redis-py.
See https://apacheignite.readme.io/docs/redis for more details on Redis integration.
'''

r = redis.StrictRedis(host='localhost', port=11211, db=0)
Expand Down

0 comments on commit 7399ae6

Please sign in to comment.