doc_id
stringlengths 36
36
| metadata
dict | input
stringlengths 28
4.3k
| output
stringlengths 11
5.45k
|
|---|---|---|---|
15bd14dd-79c2-495e-abc6-eab220efba68 | {
"language": "AsciiDoc"
} | ```asciidoc
[[security]]
== Security Plugins
Security plugins add a security layer to Elasticsearch.
[float]
=== Core security plugins
The core security plugins are:
link:/products/shield[Shield]::
Shield is the Elastic product that makes it easy for anyone to add
enterprise-grade security to their ELK stack. Designed to address the growing security
needs of thousands of enterprises using ELK today, Shield provides peace of
mind when it comes to protecting your data.
[float]
=== Community contributed security plugins
The following plugin has been contributed by our community:
* https://github.com/sscarduzio/elasticsearch-readonlyrest-plugin[Readonly REST]:
High performance access control for Elasticsearch native REST API (by Simone Scarduzio)
This community plugin appears to have been abandoned:
* https://github.com/sonian/elasticsearch-jetty[Jetty HTTP transport plugin]:
Uses Jetty to provide SSL connections, basic authentication, and request logging (by Sonian Inc.)```
Add Kerberos/SPNEGO Shield custom realm | ```asciidoc
[[security]]
== Security Plugins
Security plugins add a security layer to Elasticsearch.
[float]
=== Core security plugins
The core security plugins are:
link:/products/shield[Shield]::
Shield is the Elastic product that makes it easy for anyone to add
enterprise-grade security to their ELK stack. Designed to address the growing security
needs of thousands of enterprises using ELK today, Shield provides peace of
mind when it comes to protecting your data.
[float]
=== Community contributed security plugins
The following plugins have been contributed by our community:
* https://github.com/codecentric/elasticsearch-shield-kerberos-realm[Kerberos/SPNEGO Realm]:
Custom Shield realm to Authenticate HTTP and Transport requests via Kerberos/SPNEGO (by codecentric AG)
* https://github.com/sscarduzio/elasticsearch-readonlyrest-plugin[Readonly REST]:
High performance access control for Elasticsearch native REST API (by Simone Scarduzio)
This community plugin appears to have been abandoned:
* https://github.com/sonian/elasticsearch-jetty[Jetty HTTP transport plugin]:
Uses Jetty to provide SSL connections, basic authentication, and request logging (by Sonian Inc.)
``` |
cd8f6664-804e-4218-8b68-528083e13c0f | {
"language": "AsciiDoc"
} | ```asciidoc
[[ExchangePattern-ExchangePattern]]
= Exchange Pattern
There are many different _Message Exchange Patterns_ you can use in
messaging. This concept is also demonstrated in WSDL and JBI's MEPs.
From there xref:enterprise-integration-patterns.adoc[Enterprise
Integration Patterns] the common examples are
* Request Reply
* Event Message (or one way)
In Camel we have an
http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/ExchangePattern.html[ExchangePattern]
enumeration which can be configured on the *exchangePattern* property on
the Message Exchange indicating if a message
exchange is a one way Event Message (InOnly) or
a Request Reply message exchange (InOut).
For example to override the default pattern on a xref:components::jms-component.adoc[JMS]
endpoint you could use this URI
[source,java]
---------------------------------
jms:MyQueue?exchangePattern=InOut
---------------------------------
```
Remove dead link to javadoc of ExchangePattern | ```asciidoc
[[ExchangePattern-ExchangePattern]]
= Exchange Pattern
There are many different _Message Exchange Patterns_ you can use in
messaging. This concept is also demonstrated in WSDL and JBI's MEPs.
From there xref:enterprise-integration-patterns.adoc[Enterprise
Integration Patterns] the common examples are
* Request Reply
* Event Message (or one way)
In Camel we have an
`org.apache.camel.ExchangePattern`
enumeration which can be configured on the *exchangePattern* property on
the Message Exchange indicating if a message
exchange is a one way Event Message (InOnly) or
a Request Reply message exchange (InOut).
For example to override the default pattern on a xref:components::jms-component.adoc[JMS]
endpoint you could use this URI
[source,java]
---------------------------------
jms:MyQueue?exchangePattern=InOut
---------------------------------
``` |
b3dc1559-cb9d-408a-bdaf-00f08a6d55ae | {
"language": "AsciiDoc"
} | ```asciidoc
[role="xpack"]
[[security-api-change-password]]
=== Change Password API
The Change Password API enables you to submit a request to change the password
of a user.
==== Request
`POST _xpack/security/user/_password` +
`POST _xpack/security/user/<username>/_password`
==== Path Parameters
`username`::
(string) The user whose password you want to change. If you do not specify
this parameter, the password is changed for the current user.
==== Request Body
`password` (required)::
(string) The new password value.
==== Authorization
Every user can change their own password. Users with the `manage_security`
privilege can change passwords of other users.
==== Examples
The following example updates the password for the `elastic` user:
[source,js]
--------------------------------------------------
POST _xpack/security/user/elastic/_password
{
"password": "x-pack-test-password"
}
--------------------------------------------------
// CONSOLE
A successful call returns an empty JSON structure.
[source,js]
--------------------------------------------------
{}
--------------------------------------------------
// TESTRESPONSE
```
Fix formatting in change password API | ```asciidoc
[role="xpack"]
[[security-api-change-password]]
=== Change Password API
The Change Password API enables you to submit a request to change the password
of a user.
==== Request
`POST _xpack/security/user/_password` +
`POST _xpack/security/user/<username>/_password`
==== Path Parameters
`username`::
(string) The user whose password you want to change. If you do not specify
this parameter, the password is changed for the current user.
==== Request Body
`password` (required)::
(string) The new password value.
==== Authorization
Every user can change their own password. Users with the `manage_security`
privilege can change passwords of other users.
==== Examples
The following example updates the password for the `elastic` user:
[source,js]
--------------------------------------------------
POST _xpack/security/user/elastic/_password
{
"password": "x-pack-test-password"
}
--------------------------------------------------
// CONSOLE
A successful call returns an empty JSON structure.
[source,js]
--------------------------------------------------
{}
--------------------------------------------------
// TESTRESPONSE
``` |
7b176702-b762-4c19-90b2-39ae77001fa9 | {
"language": "AsciiDoc"
} | ```asciidoc
[[file-descriptors]]
=== File Descriptors
[NOTE]
This is only a problem for Linux and macOS and can be safely ignored if running
Elasticsearch on Windows.
Elasticsearch uses a lot of file descriptors or file handles. Running out of
file descriptors can be disastrous and will most probably lead to data loss.
Make sure to increase the limit on the number of open files descriptors for
the user running Elasticsearch to 65,536 or higher.
For the `.zip` and `.tar.gz` packages, set <<ulimit,`ulimit -n 65536`>> as
root before starting Elasticsearch, or set `nofile` to `65536` in
<<limits.conf,`/etc/security/limits.conf`>>.
RPM and Debian packages already default the maximum number of file
descriptors to 65536 and do not require further configuration.
You can check the `max_file_descriptors` configured for each node
using the <<cluster-nodes-stats>> API, with:
[source,js]
--------------------------------------------------
GET _nodes/stats/process?filter_path=**.max_file_descriptors
--------------------------------------------------
// CONSOLE
```
Reword note about windows and FDs | ```asciidoc
[[file-descriptors]]
=== File Descriptors
[NOTE]
This is only relevant for Linux and macOS and can be safely ignored if running
Elasticsearch on Windows. On Windows that JVM uses an
https://msdn.microsoft.com/en-us/library/windows/desktop/aa363858(v=vs.85).aspx[API]
limited only by available resources.
Elasticsearch uses a lot of file descriptors or file handles. Running out of
file descriptors can be disastrous and will most probably lead to data loss.
Make sure to increase the limit on the number of open files descriptors for
the user running Elasticsearch to 65,536 or higher.
For the `.zip` and `.tar.gz` packages, set <<ulimit,`ulimit -n 65536`>> as
root before starting Elasticsearch, or set `nofile` to `65536` in
<<limits.conf,`/etc/security/limits.conf`>>.
RPM and Debian packages already default the maximum number of file
descriptors to 65536 and do not require further configuration.
You can check the `max_file_descriptors` configured for each node
using the <<cluster-nodes-stats>> API, with:
[source,js]
--------------------------------------------------
GET _nodes/stats/process?filter_path=**.max_file_descriptors
--------------------------------------------------
// CONSOLE
``` |
b7313130-39a3-40bc-978d-f3514cfa3981 | {
"language": "AsciiDoc"
} | ```asciidoc
// Module included in the following assemblies:
//
// * logging/efk-logging-uninstall.adoc
[id='efk-logging-uninstall-efk_{context}']
= Uninstalling EFK from {product-title}
Use the following command to remove everything generated during the deployment.
```
Add steps to delete EFK | ```asciidoc
// Module included in the following assemblies:
//
// * logging/efk-logging-uninstall.adoc
[id='efk-logging-uninstall-efk_{context}']
= Uninstalling EFK from {product-title}
Use the following command to remove everything generated during the deployment.
----
#oc delete clusterlogging $clusterlogging_names -n openshift-logging'
----
``` |
a4e97453-ba1c-44da-9649-677a40141e5d | {
"language": "AsciiDoc"
} | ```asciidoc
[[Camel2.18.3Release-Camel2.18.3Release]]
== Camel 2.18.3 Release
### New and Noteworthy
Welcome to the 2.18.3 release which is mainly a maintenance release with
38 fixes resolved.
For further details,
see https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12339161&projectId=12311211[the
list of JIRA issues].
### Known Issues
* See <<Camel2.18.0Release,Camel 2.18.0 Release>>
### Important changes to consider when upgrading
* See <<Camel2.18.0Release,Camel 2.18.0 Release>>
### Getting the Binaries using Maven 2
To use this release in your maven project, the proper dependency
configuration that you should use in your
http://maven.apache.org/guides/introduction/introduction-to-the-pom.html[Maven
POM] is:
[source,java]
-------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-core</artifactId>
<version>2.18.3</version>
</dependency>
-------------------------------------
### Changelog
For a more detailed view of new features and bug fixes, see the:
*
https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12339161&projectId=12311211[Release
notes for 2.18.3]
```
Fix typo in Camel 2.18.3 release notes | ```asciidoc
[[Camel2.18.3Release-Camel2.18.3Release]]
== Camel 2.18.3 Release
### New and Noteworthy
Welcome to the 2.18.3 release which is mainly a maintenance release with
38 fixes resolved.
For further details,
see https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12339161&projectId=12311211[the
list of JIRA issues].
### Known Issues
* See <<Camel2.18.0Release,Camel 2.18.0 Release>>
### Important changes to consider when upgrading
* See <<Camel2.18.0Release,Camel 2.18.0 Release>>
### Getting the Binaries using Maven 2
To use this release in your maven project, the proper dependency
configuration that you should use in your
http://maven.apache.org/guides/introduction/introduction-to-the-pom.html[Maven
POM] is:
[source,java]
-------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-core</artifactId>
<version>2.18.3</version>
</dependency>
-------------------------------------
### Changelog
For a more detailed view of new features and bug fixes, see the:
https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12339161&projectId=12311211[Release
notes for 2.18.3]
``` |
28c957cf-d86e-4e1a-851f-496e26ec95e6 | {
"language": "AsciiDoc"
} | ```asciidoc
include::{generated}/overview.adoc[]
include::manual_rest_doc.adoc[]
include::{generated}/paths.adoc[]
```
Enable IDE rendering of generated Swagger documentation | ```asciidoc
:generated: ../../../target/generated-docs/asciidoc
include::{generated}/overview.adoc[]
include::manual_rest_doc.adoc[]
include::{generated}/paths.adoc[]
``` |
0f771168-ad12-4f12-9250-f1c45a1b3e86 | {
"language": "AsciiDoc"
} | ```asciidoc
[[analysis-delimited-payload-tokenfilter]]
=== Delimited Payload Token Filter
Named `delimited_payload_filter`. Splits tokens into tokens and payload whenever a delimiter character is found.
Example: "the|1 quick|2 fox|3" is split per default int to tokens `fox`, `quick` and `the` with payloads `1`, `2` and `3` respectively.
Parameters:
`delimiter`::
Character used for splitting the tokens. Default is `|`.
`encoding`::
The type of the payload. `int` for integer, `float` for float and `identity` for characters. Default is `float`.```
Fix minor issues in delimited payload token filter docs | ```asciidoc
[[analysis-delimited-payload-tokenfilter]]
=== Delimited Payload Token Filter
Named `delimited_payload_filter`. Splits tokens into tokens and payload whenever a delimiter character is found.
Example: "the|1 quick|2 fox|3" is split by default into tokens `the`, `quick`, and `fox` with payloads `1`, `2`, and `3` respectively.
Parameters:
`delimiter`::
Character used for splitting the tokens. Default is `|`.
`encoding`::
The type of the payload. `int` for integer, `float` for float and `identity` for characters. Default is `float`.``` |
af8e2b6c-1c8b-4005-b444-ad25296f27a1 | {
"language": "AsciiDoc"
} | ```asciidoc
[[releasenotes-22]]
== What's New in OpenNMS Horizon 22
=== System Requirements
TODO
=== Important Upgrade Notes
* All collectors using the JMXSecureCollector, MX4JCollector or JBossCollector must be migrated to use the JMXCollector instead.
* All monitors using the JBossMonitor or JMXSecureMonitor must be migrated to use the JMXMonitor instead.
* All detectors using the JBossDetector or MX4JDetector must be migrated to use the JMXDetector instead.
=== Breaking Changes
* JMXSecureCollector, MX4JCollector and JBossCollector have been removed. Please use the JMXCollector or Jsr160Collector instead.
* JBossMonitor and JMXSecureMonitor have been. Removed. Use the JMXMonitor instead.
* JBossDetector and MX4JDetector have been removed. Use the JMXDetector instead.
=== New Features
=== Dependency Updates
```
Make it more clear which collector/detector/monitor to use instead | ```asciidoc
[[releasenotes-22]]
== What's New in OpenNMS Horizon 22
=== System Requirements
TODO
=== Important Upgrade Notes
* All collectors using the `JMXSecureCollector`, `MX4JCollector` or `JBossCollector` must be migrated to use the `Jsr160Collector` instead.
* All monitors using the `JBossMonitor` or `JMXSecureMonitor` must be migrated to use the `Jsr160Monitor` instead.
* All detectors using the `JBossDetector` or `MX4JDetector` must be migrated to use the `Jsr160Detector` instead.
=== Breaking Changes
* `JMXSecureCollector`, `MX4JCollector` and `JBossCollector` have been removed. Please use the `Jsr160Collector` instead.
* `JBossMonitor` and `JMXSecureMonitor` have been. Removed. Use the `Jsr160Monitor` instead.
* `JBossDetector` and `MX4JDetector` have been removed. Use the `Jsr160Detector` instead.
=== New Features
=== Dependency Updates
``` |
22e358a1-36ea-46d9-a6f5-1c87070ad9db | {
"language": "AsciiDoc"
} | ```asciidoc
= Spring Cloud Bus
:github: https://github.com/spring-cloud/spring-cloud-config
:githubmaster: {github}/tree/master
:docslink: {githubmaster}/docs/src/main/asciidoc
:toc:
include::intro.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing-docs.adoc[]
== Quick Start
include::quickstart.adoc[]
== Customizing the AMQP ConnectionFactory
If you are using AMQP there needs to be a `ConnectionFactory` (from
Spring Rabbit) in the application context. If there is a single
`ConnectionFactory` it will be used, or if there is a one qualified as
`@BusConnectionFactory` it will be preferred over others, otherwise
the `@Primary` one will be used. If there are multiple unqualified
connection factories there will be an error.
Note that Spring Boot (as of 1.2.2) creates a `ConnectionFactory` that
is _not_ `@Primary`, so if you want to use one connection factory for
the bus and another for business messages, you need to create both,
and annotate them `@BusConnectionFactory` and `@Primary` respectively.```
Add paragraph about destination parameter in Bus endpoints | ```asciidoc
= Spring Cloud Bus
:github: https://github.com/spring-cloud/spring-cloud-config
:githubmaster: {github}/tree/master
:docslink: {githubmaster}/docs/src/main/asciidoc
:toc:
include::intro.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing-docs.adoc[]
== Quick Start
include::quickstart.adoc[]
== Addressing an Instance
The HTTP endpoints accept a "destination" parameter, e.g. "/bus/refresh?destination=customers:9000", where the destination is an `ApplicationContext` ID. If the ID is owned by an instance on the Bus then it will process the message and all other instances will ignore it. Spring Boot sets the ID for you in the `ContextIdApplicationContextInitializer` to a combination of the `spring.application.name`, active profiles and `server.port` by default.
== Customizing the AMQP ConnectionFactory
If you are using AMQP there needs to be a `ConnectionFactory` (from
Spring Rabbit) in the application context. If there is a single
`ConnectionFactory` it will be used, or if there is a one qualified as
`@BusConnectionFactory` it will be preferred over others, otherwise
the `@Primary` one will be used. If there are multiple unqualified
connection factories there will be an error.
Note that Spring Boot (as of 1.2.2) creates a `ConnectionFactory` that
is _not_ `@Primary`, so if you want to use one connection factory for
the bus and another for business messages, you need to create both,
and annotate them `@BusConnectionFactory` and `@Primary` respectively.``` |
00166b0a-4e9c-40ad-8673-7af2f7ab74b6 | {
"language": "AsciiDoc"
} | ```asciidoc
Ctrlflow Automated Error Reporting Client Examples
==================================================
Examples of how to use various clients to communicate with the https://www.ctrlflow.com/automated-error-reporting/[Ctrlflow Automated Error Reporting (AER) server].
At the moment, the following examples are available:
link:logback-java-example[Log4j 2 Java Example]::
If you are developing a stand-alone *Java application* that uses the popular https://logging.apache.org/log4j/2.x/[*Log4j 2*] logging framework, have a look at this example.
It shows you how to configure Log4j 2 to send error reports to a Ctrlflow AER server.
link:logback-java-example[Logback Java Example]::
If you are developing a stand-alone *Java application* that uses the popular http://logback.qos.ch/[*Logback*] logging framework, have a look at this example.
It shows you how to configure Logback to send error reports to a Ctrlflow AER server.
link:simple-java-example[Simple Java Example]::
If you are developing a stand-alone *Java application* that uses none of the logging frameworks supported out-of-the-box, have a look at this example.
It shows you how to use the Ctrlflow AER Simple Client to send caught exceptions to your server.
```
Fix link to Log4j 2 example | ```asciidoc
Ctrlflow Automated Error Reporting Client Examples
==================================================
Examples of how to use various clients to communicate with the https://www.ctrlflow.com/automated-error-reporting/[Ctrlflow Automated Error Reporting (AER) server].
At the moment, the following examples are available:
link:log4j2-java-example[Log4j 2 Java Example]::
If you are developing a stand-alone *Java application* that uses the popular https://logging.apache.org/log4j/2.x/[*Log4j 2*] logging framework, have a look at this example.
It shows you how to configure Log4j 2 to send error reports to a Ctrlflow AER server.
link:logback-java-example[Logback Java Example]::
If you are developing a stand-alone *Java application* that uses the popular http://logback.qos.ch/[*Logback*] logging framework, have a look at this example.
It shows you how to configure Logback to send error reports to a Ctrlflow AER server.
link:simple-java-example[Simple Java Example]::
If you are developing a stand-alone *Java application* that uses none of the logging frameworks supported out-of-the-box, have a look at this example.
It shows you how to use the Ctrlflow AER Simple Client to send caught exceptions to your server.
``` |
20545082-f161-4da2-a4e7-edda8348e913 | {
"language": "AsciiDoc"
} | ```asciidoc
This project provides Etcd integrations for Spring Boot apps through autoconfiguration
and binding to the Spring Environment and other Spring programming model idioms. With a few
simple annotations you can quickly enable and configure the common patterns inside your
application and build large distributed systems with Etcd based components. The
patterns provided include Service Discovery, Circuit Breaker and Configuration.
Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon) are provided by
integration with Spring Cloud Netflix.
```
Remove reference to "circuit breaker" | ```asciidoc
This project provides Etcd integrations for Spring Boot apps through autoconfiguration
and binding to the Spring Environment and other Spring programming model idioms. With a few
simple annotations you can quickly enable and configure the common patterns inside your
application and build large distributed systems with Etcd based components. The
patterns provided include Service Discovery and Configuration.
Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon) are provided by
integration with Spring Cloud Netflix.
``` |
1092e308-a566-4eb1-9128-0c4f8cdaa963 | {
"language": "AsciiDoc"
} | ```asciidoc
[[analysis-keyword-marker-tokenfilter]]
=== Keyword Marker Token Filter
Protects words from being modified by stemmers. Must be placed before
any stemming filters.
[cols="<,<",options="header",]
|=======================================================================
|Setting |Description
|`keywords` |A list of words to use.
|`keywords_path` |A path (either relative to `config` location, or
absolute) to a list of words.
|`ignore_case` |Set to `true` to lower case all words first. Defaults to
`false`.
|=======================================================================
Here is an example:
[source,js]
--------------------------------------------------
index :
analysis :
analyzer :
myAnalyzer :
type : custom
tokenizer : standard
filter : [lowercase, protwods, porter_stem]
filter :
protwods :
type : keyword_marker
keywords_path : analysis/protwords.txt
--------------------------------------------------
```
Fix typo in sample json | ```asciidoc
[[analysis-keyword-marker-tokenfilter]]
=== Keyword Marker Token Filter
Protects words from being modified by stemmers. Must be placed before
any stemming filters.
[cols="<,<",options="header",]
|=======================================================================
|Setting |Description
|`keywords` |A list of words to use.
|`keywords_path` |A path (either relative to `config` location, or
absolute) to a list of words.
|`ignore_case` |Set to `true` to lower case all words first. Defaults to
`false`.
|=======================================================================
Here is an example:
[source,js]
--------------------------------------------------
index :
analysis :
analyzer :
myAnalyzer :
type : custom
tokenizer : standard
filter : [lowercase, protwords, porter_stem]
filter :
protwords :
type : keyword_marker
keywords_path : analysis/protwords.txt
--------------------------------------------------
``` |
b9fe4ee0-6946-429f-a6f9-f9f3fe04dda8 | {
"language": "AsciiDoc"
} | ```asciidoc
== Bugfix Release
:docname: 20200614-bugfix-release
:page-publish_date: 2020-06-14
:page-layout: news-article
The `revapi-java` extension released a couple of weeks ago contained a rather ugly regression that caused an index out
of bounds exception on interfaces that override methods from `java.lang.Object`.
This has now been fixed in the new `0.21.1` version of `revapi-java`. Please upgrade if you have been hit by this bug.
```
Fix the news article to start with a top-level header. | ```asciidoc
= Bugfix Release
:docname: 20200614-bugfix-release
:page-publish_date: 2020-06-14
:page-layout: news-article
The `revapi-java` extension released a couple of weeks ago contained a rather ugly regression that caused an index out
of bounds exception on interfaces that override methods from `java.lang.Object`.
This has now been fixed in the new `0.21.1` version of `revapi-java`. Please upgrade if you have been hit by this bug.
``` |
70634ba2-9d37-4741-8e7a-e6d92f6063ba | {
"language": "AsciiDoc"
} | ```asciidoc
```
Write a trouble shooting guide | ```asciidoc
== Troubleshooting
[qanda]
Why does `Config.setSize(...)` not take effect?::
The configuration state of a `Config` object is only read in the constructor of the pool, so changing the configuration after the pool has been created has no effect.
Look at the `ResizablePool` interface for changing the size of an existing pool.
Why am I getting an `stormpot.PoolException: Slot release from bad state: 1` exception?::
The slot has already been released.
Either you are calling the `release` method twice, or you are sharing the `Poolable` instances without the consent of the pool.
My program won't stop running, or Stormpot leaves a thread running!::
Stormpot creates a background thread that is non-daemon by default.
This thread will run until the pool has been shut down with `LifecycledPool#shutdown`, and all the `Poolable` instances in it has been deallocated.
If you have started the shut down process but it never finishes, then you have probably leaked an object.
All objects in the pool must be released back to the pool before the shut down can complete.
How do I find out if I have leaked an object?::
There are two kinds of leaks: one where the program forgets to `release` an object back to the pool, and one where the program both forgets to `release`, and also forgets the reference to the object, so it becomes garbage collected.
You can diagnose the first case by taking a heap dump of the running program – possibly after you have initiated the shut down process and waited for it to complete for a little while – and look for any lingering `stormpot.BSlot`, `stormpot.QSlot` objects, or instances of your `Poolable` implementation, and see where they are referenced.
The precise leak detector will notice the last case, but cannot tell you where in the code the problem is.
Why are there so many "Stormpot" threads in my program?::
Stormpot starts a thread for every pool instance you create.
It does not share threads across pool instances.
I'm not allowed to start threads in my environment, or I get an exception about not being able to start a thread when I try to create an pool instance!::
Some environments restrict the ability to create threads.
These environments often have a way to get around that restriction, for instance by creating threads with a particular `ThreadGroup` or creating the thread in a particular privileged part of the code.
Stormpot can be configured to use a specific `ThreadFactory` for creating its threads.
So giving it a `ThreadFactory` that knows how to create threads in your particular environment, is the way to get around these restrictions.
``` |
ca2dd9c6-51c6-4956-b278-7bf9914cf2fa | {
"language": "AsciiDoc"
} | ```asciidoc
# SAAV
Software application to analyse and visualise research output in the humanities and social sciences
# Documentation
* link:CONTRIBUTING.adoc[Development Setup]
* link:docs/architecture-and-design.adoc[Architecture & Design]
* link:docs/deployment.adoc[Deployment]
# Live
The latest milestone is deployed via GitHub Pages:
* http://fhnw-saav.github.io/saav/[Live Site] (http://fhnw-saav.github.io/saav/version.txt[inspect current version])
```
Revert "Remove travis badge until false positives are fixed" | ```asciidoc
# SAAV image:https://travis-ci.org/fhnw-saav/saav.svg?branch=master["Build Status", link="https://travis-ci.org/fhnw-saav/saav"]
Software application to analyse and visualise research output in the humanities and social sciences
# Documentation
* link:CONTRIBUTING.adoc[Development Setup]
* link:docs/architecture-and-design.adoc[Architecture & Design]
* link:docs/deployment.adoc[Deployment]
# Live
The latest milestone is deployed via GitHub Pages:
* http://fhnw-saav.github.io/saav/[Live Site] (http://fhnw-saav.github.io/saav/version.txt[inspect current version])
``` |
89a85181-84d5-45c3-bf8e-b9dfb90d4fd6 | {
"language": "AsciiDoc"
} | ```asciidoc
[[search-request-fielddata-fields]]
=== Field Data Fields
Allows to return the field data representation of a field for each hit, for
example:
[source,js]
--------------------------------------------------
{
"query" : {
...
},
"fielddata_fields" : ["test1", "test2"]
}
--------------------------------------------------
Field data fields can work on fields that are not stored.
It's important to understand that using the `fielddata_fields` parameter will
cause the terms for that field to be loaded to memory (cached), which will
result in more memory consumption.
```
Add link to field data docs from field data fields | ```asciidoc
[[search-request-fielddata-fields]]
=== Field Data Fields
Allows to return the <<fielddata,field data>> representation of a field for each hit, for
example:
[source,js]
--------------------------------------------------
{
"query" : {
...
},
"fielddata_fields" : ["test1", "test2"]
}
--------------------------------------------------
Field data fields can work on fields that are not stored.
It's important to understand that using the `fielddata_fields` parameter will
cause the terms for that field to be loaded to memory (cached), which will
result in more memory consumption.
``` |
f53ae502-25d0-49cd-bfc7-c47f65606e7e | {
"language": "AsciiDoc"
} | ```asciidoc
= A test for embedding a SVG image
.Caption for a SVG diagram
image::Vsw9cGkj8bJjEBr6.svg[width=417]
* I'd like to remove a redundant vertical space between the diagram above and the caption.
* I suppose Height 275 below is too much.
<<
/Name /Im7
/Type /XObject
/Length 29 0 R
/Filter /FlateDecode
/Subtype /Image
/Width 417
/Height 275
/BitsPerComponent 8
/ColorSpace /DeviceGray
>>
image::Vsw9cGkj8bJjEBr6.svg[width=417]
* There is still a redundant vertical space even when I do not have a caption, so the redundant space seems to be inside the image.
image::Vsw9cGkj8bJjEBr6.svg[width=417,height=242]
* However, the diagram becomes too small if I set the height as well as the width.
* And there still exists a redundant vertical space. I'd like to remove it!
```
Update explanation about adding width and height to the root svg element | ```asciidoc
= A test for embedding a SVG image
.Caption for a SVG diagram
image::Vsw9cGkj8bJjEBr6.svg[]
You must be add `width` and `height` attributes to the root `<svg>` element to avoid
redundant spaces.
In the above example, I added `width="441.0" height="265.5"`.
``` |
ef8ead23-d22d-442c-a9e1-01a6990996ff | {
"language": "AsciiDoc"
} | ```asciidoc
[[plannerIntroduction]]
= OptaPlanner Introduction
:doctype: book
:sectnums:
:toc: left
:icons: font
:experimental:
:sourcedir: .
include::Section-What_is_OptaPlanner.adoc[leveloffset=+2]
include::Section-Section-What_is_a_planning_problem.adoc[leveloffset=+2]
include::Section-Requirements.adoc[leveloffset=+2]
include::Section-Governance.adoc[leveloffset=+2]
include::Section-Download_and_run_the_examples.adoc[leveloffset=+2]
```
Fix leveloffset problem + invalid include problem | ```asciidoc
[[plannerIntroduction]]
= OptaPlanner Introduction
:doctype: book
:sectnums:
:toc: left
:icons: font
:experimental:
:sourcedir: .
include::Section-What_is_OptaPlanner.adoc[]
include::Section-What_is_a_planning_problem.adoc[]
include::Section-Requirements.adoc[]
include::Section-Governance.adoc[]
include::Section-Download_and_run_the_examples.adoc[]
``` |
4cd9c589-bd68-4d39-9cd9-5a3a65ecb283 | {
"language": "AsciiDoc"
} | ```asciidoc
:gfdl-enabled:
OsmoBTS User Manual
===================
Harald Welte <[email protected]>
include::../common/chapters/preface.adoc[]
include::chapters/overview.adoc[]
include::../common/chapters/abis.adoc[]
include::chapters/interfaces.adoc[]
include::chapters/control.adoc[]
include::../common/chapters/vty.adoc[]
include::../common/chapters/logging.adoc[]
include::chapters/configuration.adoc[]
include::chapters/dynamic-timeslots.adoc[]
include::chapters/bts-models.adoc[]
include::chapters/architecture.adoc[]
include::../common/chapters/control_if.adoc[]
include::../common/chapters/port_numbers.adoc[]
include::../common/chapters/bibliography.adoc[]
include::../common/chapters/glossary.adoc[]
include::../common/chapters/gfdl.adoc[]
```
Introduce chapter trx_if.adoc and add it to OsmoTRX and OsmoBTS | ```asciidoc
:gfdl-enabled:
OsmoBTS User Manual
===================
Harald Welte <[email protected]>
include::../common/chapters/preface.adoc[]
include::chapters/overview.adoc[]
include::../common/chapters/abis.adoc[]
include::chapters/interfaces.adoc[]
include::chapters/control.adoc[]
include::../common/chapters/vty.adoc[]
include::../common/chapters/logging.adoc[]
include::chapters/configuration.adoc[]
include::chapters/dynamic-timeslots.adoc[]
include::chapters/bts-models.adoc[]
include::chapters/architecture.adoc[]
include::../common/chapters/trx_if.adoc[]
include::../common/chapters/control_if.adoc[]
include::../common/chapters/port_numbers.adoc[]
include::../common/chapters/bibliography.adoc[]
include::../common/chapters/glossary.adoc[]
include::../common/chapters/gfdl.adoc[]
``` |
652ff9a5-78b6-4b90-85b6-c100da143b86 | {
"language": "AsciiDoc"
} | ```asciidoc
= JSR 377 - Desktop|Embedded Application API
Contains the specification and API sources for link:https://jcp.org/en/jsr/detail?id=377[JSR-377].
== Additional resources
link:http://jsr377-api.40747.n7.nabble.com[Forum / Mailing List]
```
Add a gitter chat badge | ```asciidoc
= JSR 377 - Desktop|Embedded Application API
Contains the specification and API sources for link:https://jcp.org/en/jsr/detail?id=377[JSR-377].
image:https://badges.gitter.im/Join%20Chat.svg[Gitter, link="https://gitter.im/jsr377/jsr377-api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge"]
== Additional resources
link:http://jsr377-api.40747.n7.nabble.com[Forum / Mailing List]
``` |
9f907dbe-4d13-4fe6-a399-aca61e5a0dc6 | {
"language": "AsciiDoc"
} | ```asciidoc
= Badging Your App
You can set the badge count on your app's icon using:
[source,csharp]
----
bool SetBadgeCount(int count)
----
.Parameters
[cols="1,2a"]
|===
|Parameter |Description
|count |The number to assign as a badge to the application's icon
|===
This function will return `true` if it was able to set the badge count for your
app's icon, or `false` otherwise.
On Android, this functionality uses the https://github.com/leolin310148/ShortcutBadger[ShortcutBadger library by Leo Sin].
== Known Issues
[cols="1,2a"]
|===
|Date |Issue
|October 11, 2018 |Google Nexus and Pixel devices are not supported, because the
launcher used does not support badging.
Samsung devices running Android 8+ are not supported (https://github.com/leolin310148/ShortcutBadger/pull/268[GitHub Issue]).
[cols="1,2a"]
!===
!Since Version !Status
!All Versions !Can't Fix
!===
```
Fix close tag on table | ```asciidoc
= Badging Your App
You can set the badge count on your app's icon using:
[source,csharp]
----
bool SetBadgeCount(int count)
----
.Parameters
[cols="1,2a"]
|===
|Parameter |Description
|count |The number to assign as a badge to the application's icon
|===
This function will return `true` if it was able to set the badge count for your
app's icon, or `false` otherwise.
On Android, this functionality uses the https://github.com/leolin310148/ShortcutBadger[ShortcutBadger library by Leo Sin].
== Known Issues
[cols="1,2a"]
|===
|Date |Issue
|October 11, 2018 |Google Nexus and Pixel devices are not supported, because the
launcher used does not support badging.
Samsung devices running Android 8+ are not supported (https://github.com/leolin310148/ShortcutBadger/pull/268[GitHub Issue]).
[cols="1,2a"]
!===
!Since Version !Status
!All Versions !Can't Fix
!===
|===
``` |
9b5b0473-ad72-458a-9dde-99cb8b9e9047 | {
"language": "AsciiDoc"
} | ```asciidoc
:_content-type: ASSEMBLY
[id="installing-ossm"]
= Installing the Operators
include::modules/ossm-document-attributes.adoc[]
:context: installing-ossm
toc::[]
To install {ProductName}, first install the required Operators on {product-title} and then create a `ServiceMeshControlPlane` resource to deploy the control plane.
.Prerequisites
* Read the xref:../../service_mesh/v2x/preparing-ossm-installation.adoc#preparing-ossm-installation[Preparing to install {ProductName}] process.
* An account with the `cluster-admin` role. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.
The following steps show how to install a basic instance of {ProductName} on {product-title}.
include::modules/ossm-installation-activities.adoc[leveloffset=+1]
[WARNING]
====
Do not install Community versions of the Operators. Community Operators are not supported.
====
include::modules/ossm-install-ossm-operator.adoc[leveloffset=+1]
== Next steps
Create a `ServiceMeshControlPlane` resource to configure the components of {ProductShortName}. For more information, see xref:../../service_mesh/v2x/ossm-create-smcp.adoc#ossm-create-smcp[Creating the ServiceMeshControlPlane].
```
Add admonition to overview of Installing the Operators topic | ```asciidoc
:_content-type: ASSEMBLY
[id="installing-ossm"]
= Installing the Operators
include::modules/ossm-document-attributes.adoc[]
:context: installing-ossm
toc::[]
To install {ProductName}, first install the required Operators on {product-title} and then create a `ServiceMeshControlPlane` resource to deploy the control plane.
[NOTE]
====
This basic installation is configured based on the default OpenShift settings and is not designed for production use. Use this default installation to verify your installation, and then configure your service mesh for your specific environment.
====
.Prerequisites
* Read the xref:../../service_mesh/v2x/preparing-ossm-installation.adoc#preparing-ossm-installation[Preparing to install {ProductName}] process.
* An account with the `cluster-admin` role. If you use {product-dedicated}, you must have an account with the `dedicated-admin` role.
The following steps show how to install a basic instance of {ProductName} on {product-title}.
include::modules/ossm-installation-activities.adoc[leveloffset=+1]
[WARNING]
====
Do not install Community versions of the Operators. Community Operators are not supported.
====
include::modules/ossm-install-ossm-operator.adoc[leveloffset=+1]
== Next steps
Create a `ServiceMeshControlPlane` resource to configure the components of {ProductShortName}. For more information, see xref:../../service_mesh/v2x/ossm-create-smcp.adoc#ossm-create-smcp[Creating the ServiceMeshControlPlane].
``` |
194cc32f-00bb-4d7d-a305-cd074e453727 | {
"language": "AsciiDoc"
} | ```asciidoc
[[query-dsl-match-all-query]]
== Match All Query
The most simple query, which matches all documents, giving them all a `_score`
of `1.0`.
[source,js]
--------------------------------------------------
{ "match_all": {} }
--------------------------------------------------
The `_score` can be changed with the `boost` parameter:
[source,js]
--------------------------------------------------
{ "match_all": { "boost" : 1.2 }}
--------------------------------------------------
```
Add query to Query DSL documentation | ```asciidoc
[[query-dsl-match-all-query]]
== Match All Query
The most simple query, which matches all documents, giving them all a `_score`
of `1.0`.
[source,js]
--------------------------------------------------
{ "match_all": {} }
--------------------------------------------------
The `_score` can be changed with the `boost` parameter:
[source,js]
--------------------------------------------------
{ "match_all": { "boost" : 1.2 }}
--------------------------------------------------
[[query-dsl-match-none-query]]
[float]
== Match None Query
This is the inverse of the `match_all` query, which matches no documents.
[source,js]
--------------------------------------------------
{ "match_none": {} }
--------------------------------------------------
``` |
be2c0f24-29ce-4564-9d78-eedb76a47955 | {
"language": "AsciiDoc"
} | ```asciidoc
= Edge Documentation
Edge is a starting point for creating Clojure projects.
Not sure if Edge is for you? See <<why-edge.adoc#,Why Edge?>>.
== First Steps
Are you new to Edge?
This is the place to start!
Install the tools::
. link:https://clojure.org/guides/getting_started[Install clj] (<<windows.adoc#,Instructions for Windows users>>)
. <<editor.adoc#,Set up your editor for Clojure>>
Download Edge::
. <<adaptation.adoc#,Adapting Edge for new projects>>
// Paste Tutorial::
// . Creating a new project
// . Create paste
// . Deploy to Elastic Beanstalk
Useful References::
. <<dev-guide.adoc#,Dev guide>>
== Topical Guides
. Configuration
. Components
. <<dev-guide.adoc#,Dev guide>>
== Release
Releasing your application is an important part of the lifecycle of your project.
Edge provides multiple mechanisms for making releasing easier.
// * Packed and unpacked deployments
* <<uberjar.adoc#,Producing an Uberjar>>
* <<elastic-beanstalk.adoc#,Using the Elastic Beanstalk Quickstart>>
* <<socket-repl.adoc#,Setting up a socket REPL>>
== The Edge Project
* <<why-edge.adoc#,Why Edge?>>
* <<guidelines.adoc#,Contributing Guidelines>>
* Getting help
* How to get involved
* License
```
Comment out dead links in docs | ```asciidoc
= Edge Documentation
Edge is a starting point for creating Clojure projects.
Not sure if Edge is for you? See <<why-edge.adoc#,Why Edge?>>.
== First Steps
Are you new to Edge?
This is the place to start!
Install the tools::
. link:https://clojure.org/guides/getting_started[Install clj] (<<windows.adoc#,Instructions for Windows users>>)
. <<editor.adoc#,Set up your editor for Clojure>>
Download Edge::
. <<adaptation.adoc#,Adapting Edge for new projects>>
// Paste Tutorial::
// . Creating a new project
// . Create paste
// . Deploy to Elastic Beanstalk
Useful References::
. <<dev-guide.adoc#,Dev guide>>
== Topical Guides
//. Configuration
//. Components
. <<dev-guide.adoc#,Dev guide>>
== Release
Releasing your application is an important part of the lifecycle of your project.
Edge provides multiple mechanisms for making releasing easier.
// * Packed and unpacked deployments
* <<uberjar.adoc#,Producing an Uberjar>>
* <<elastic-beanstalk.adoc#,Using the Elastic Beanstalk Quickstart>>
* <<socket-repl.adoc#,Setting up a socket REPL>>
== The Edge Project
* <<why-edge.adoc#,Why Edge?>>
* <<guidelines.adoc#,Contributing Guidelines>>
//* Getting help
//* How to get involved
//* License
``` |
a59af5f4-ea0a-4918-921a-4b9a4600607a | {
"language": "AsciiDoc"
} | ```asciidoc
= JBoss Fuse
:toc:
:icons: font
Red Hat JBoss Fuse is a lightweight, flexible integration platform that enables rapid integration
across the extended enterprise—on-premise or in the cloud.
Based on Apache Camel, Fuse leverages pattern-based integration, a rich connector catalog, and extensive
data transformation capabilities to enables users to integrate anything.
== Development Process
There are two ways of building JBoss Fuse 7:
* using Jenkins pipeline
* using plain old Maven
=== Building using Jenkins Pipeline
TO DESCRIBE
=== Building locally using Maven
Basic invocation of `mvn clean install` will build Fuse minimal and full distro. Minimal distribution is
maintained only for presentation and test purposes.
We can enable additional profiles:
* `mvn -Pcs validate` - Run checkstyle checks
* `mvn -Plicense process-sources` - regenerate license headers in configured files using `license-header.txt`
* `mvn -Ptest verify` - run integration test inside `fuse-itests` module
(In order to generate license headers and/or perform checkstyle checks, it's recommended to use `-Plicense,test` and
`-Pcs,test` respectively).
```
Add shield link to Stack Overflow | ```asciidoc
image:https://img.shields.io/badge/stack%20overflow-jbossfuse-red.svg?colorB=cc0000[link="https://stackoverflow.com/questions/tagged/jbossfuse"]
= JBoss Fuse
:toc:
:icons: font
Red Hat JBoss Fuse is a lightweight, flexible integration platform that enables rapid integration
across the extended enterprise—on-premise or in the cloud.
Based on Apache Camel, Fuse leverages pattern-based integration, a rich connector catalog, and extensive
data transformation capabilities to enables users to integrate anything.
== Development Process
There are two ways of building JBoss Fuse 7:
* using Jenkins pipeline
* using plain old Maven
=== Building using Jenkins Pipeline
TO DESCRIBE
=== Building locally using Maven
Basic invocation of `mvn clean install` will build Fuse minimal and full distro. Minimal distribution is
maintained only for presentation and test purposes.
We can enable additional profiles:
* `mvn -Pcs validate` - Run checkstyle checks
* `mvn -Plicense process-sources` - regenerate license headers in configured files using `license-header.txt`
* `mvn -Ptest verify` - run integration test inside `fuse-itests` module
(In order to generate license headers and/or perform checkstyle checks, it's recommended to use `-Plicense,test` and
`-Pcs,test` respectively).
``` |
c2252105-43dc-496e-a917-ab5c0db3229c | {
"language": "AsciiDoc"
} | ```asciidoc
Quick-n-dirty PHP router
========================
[quote]
A *transitionary* router to help upgrading an old PHP codebase to a more modern
set of standards.
More information is available
http://ciarand.me/posts/refactoring-php-part-1/[on my blog].
Usage
-----
Require it in your project:
[source, bash]
composer require 'ciarand\quick-n-dirty-router' 'dev-master'
Move all your files into a handlers dir:
[source, bash]
----
# assuming you're in the webroot
mkdir ../handlers/
find . -name '*.php' | while read file; do
echo mv "$file" "../handlers/$file";
done;
----
Put this in an `index.php` file in your web root:
[source, php]
----
<?php // index.php
require "vendor/autoload.php";
use RestlessCo\Router;
// where you keep your scripts (outside of the public web dir)
$handler_dir = __DIR__ "/../handler";
// the script you'd like to handle 404s with
$missing_script = $handler_dir . "/404.php";
$requested_path = $handler_dir . "/" . Router::scriptForEnv($_SERVER);
return require (file_exists($requested_path))
? $requested_path
: $missing_script;
----
Tests
-----
[source, bash]
vendor/bin/phpunit
License
-------
MIT, full text is in the link:LICENSE[LICENSE file].
```
Remove echo from mv script | ```asciidoc
Quick-n-dirty PHP router
========================
[quote]
A *transitionary* router to help upgrading an old PHP codebase to a more modern
set of standards.
More information is available
http://ciarand.me/posts/refactoring-php-part-1/[on my blog].
Usage
-----
Require it in your project:
[source, bash]
composer require 'ciarand\quick-n-dirty-router' 'dev-master'
Move all your files into a handlers dir:
[source, bash]
----
# assuming you're in the webroot
mkdir ../handlers/
find . -name '*.php' | while read file; do
mv "$file" "../handlers/$file";
done;
----
Put this in an `index.php` file in your web root:
[source, php]
----
<?php // index.php
require "vendor/autoload.php";
use RestlessCo\Router;
// where you keep your scripts (outside of the public web dir)
$handler_dir = __DIR__ "/../handler";
// the script you'd like to handle 404s with
$missing_script = $handler_dir . "/404.php";
$requested_path = $handler_dir . "/" . Router::scriptForEnv($_SERVER);
return require (file_exists($requested_path))
? $requested_path
: $missing_script;
----
Tests
-----
[source, bash]
vendor/bin/phpunit
License
-------
MIT, full text is in the link:LICENSE[LICENSE file].
``` |
daa884d8-ce5e-4687-afb8-4c08eaebf2d9 | {
"language": "AsciiDoc"
} | ```asciidoc
= Parity
ifdef::env-github,env-browser[:outfilesuffix: .adoc]
ifndef::rootdir[:rootdir: ../]
:imagesdir: {rootdir}/images
https://ethcore.io/parity.html[Parity] is an Ethereum client
actively developed as an open source project on https://github.com/ethcore/parity[github].
There are a default configuration (link:parity/default.toml[parity/default.toml])
used by default by Vagrant.
----
vagrant up
----
However, you can free to use your own alternative variants, for example:
----
env CONFIG=with_dapps CHAIN=example1 vagrant up
----
or even:
----
env CONFIG=with_dapps CHAIN=example1 vagrant provision
----
In these examples are used simple name conventions.
'`with_dapps`' implies the existence of configuration file at 'parity/with_dapps.toml'.
For '`with_dapps`' it corresponds to 'parity/chain/example1.json' respectively.
```
Fix relative link for AsciiDoc | ```asciidoc
= Parity
ifdef::env-github,env-browser[:outfilesuffix: .adoc]
ifndef::rootdir[:rootdir: ../]
:imagesdir: {rootdir}/images
https://ethcore.io/parity.html[Parity] is an Ethereum client
actively developed as an open source project on https://github.com/ethcore/parity[github].
There are a default configuration (link:../parity/default.toml[parity/default.toml])
used by default by Vagrant.
----
vagrant up
----
However, you are free to use your own alternative variants, for example:
----
env CONFIG=with_dapps CHAIN=example1 vagrant up
----
or even:
----
env CONFIG=with_dapps CHAIN=example1 vagrant provision
----
In these examples are used simple name conventions.
'`with_dapps`' implies the existence of configuration file at 'parity/with_dapps.toml'.
For '`with_dapps`' it corresponds to 'parity/chain/example1.json' respectively.
``` |
86017d60-4b04-4e5d-87f2-9b496a0ccdca | {
"language": "AsciiDoc"
} | ```asciidoc
Basic Command Line Guide
------------------------
This is a guide for common command line commands.
.sudo
----
Allows a user with proper permissions (such as an admin) to execute commands. You will need to enter a password for the command to run.
$ sudo <command>
e.g.
$ make install
(usually will output an error, so use sudo)
$ sudo make install
(you will then be prompted to input the admins password)
----
.cd
----
Used to navigate through directories
$ cd <directoryname>
$ cd .. (navigates to previous directory)
----
.ls
----
Used to list the contents in the current directory
$ ls
----
.rm
----
Used to delete files or directories
$ rm <file_name/directory_name>
----
.cp
----
Used to make copies of files or directories
$ cp <file_name/directory_name>
----
.mv
----
Used to move or rename files
$ mv <file> <target_directory> (Moves file to target directory)
$ mv <old_file_name> <new_file_name> (Changes name of the file)
----
.pwd
----
Used to print the name of the working directory. i.e. Show where you are.
$ pwd
----
```
Clean up documentation for basic command line guide for accuracy and aeshetics. | ```asciidoc
= Basic Command Line Guide
This is a guide for common command line commands.
. `cd` is used to navigate through directories.
The usage is `cd <directory>`.
You can use `..` to go up a level.
+
.Example
----
cd Documents/
cd ..
----
. `ls` is used to list the contents in the current directory.
This command does not normally need any arguments.
. `rm` is used to delete files or directories.
The usage is `rm <file>`.
To delete directories, add the recursive flag `-r`.
+
.Example
----
rm hello.txt
rm -r Documents/
----
. `cp` is used to make copies of files or directories.
The usage is `cp <file> <destination>`.
To copy directories, add the recursive flag `-r`.
+
.Copying a File Example
----
cp hello.txt Documents/hello.txt
----
+
.Copying a Directory Example
----
cp -r Documents/ Downloads/
----
. `mv` is used to move or rename files
The usage is `mv <file> <destination>`.
Unlike the other commands, no extra flag is needed to move directories.
+
.Moving a File Example
----
mv hello.txt Documents/
----
+
.Renaming a File Example
----
mv hello.txt world.txt
----
. `pwd` is used to print the name of the working directory, in other words, show where you are.
This command does not normally need any arguments.
. `sudo` can precede a command to act with administrative rights.
If you run a command with a permission error, a common fix is to run the same command but with sudo.
+
.Example
----
sudo mv /opt/soarr /opt/soar
----
+
But be warned, because sudo elevates privileges, it can be a security hazard!
``` |
9159b855-2c97-45eb-9c88-14e3d044b61d | {
"language": "AsciiDoc"
} | ```asciidoc
---
layout: documentation
---
:title: Muon Java
:date: 2015-01-05 11:40
:comments: true
:sharing: true
:source-highlighter: pygments
:toc: right
:toc-title: Muon Java
:toclevels: 6
# Muon Java
Muon Java is the implementation of the Muon microservices toolkit, for the Java platform. Muon enables you to easily build
microservices in many languages that have richer, more performant and fully reactive communication semantics and gain access
to Muon compatible services written in other languages without having to sacrifice the rich semantics or performance.
.Contributing
****
Muon and the ecosystem services are open source.
Contribute to Muon Java and this documentation at http://github.com/muoncore/muon-java
****
include::java/SNAPSHOT/core.adoc[leveloffset=+1]
include::java/SNAPSHOT/eventsystem.adoc[leveloffset=+1]
include::java/SNAPSHOT/spring.adoc[leveloffset=+1]
include::java/SNAPSHOT/extension.adoc[leveloffset=+1]
```
Update docs in the documentation project | ```asciidoc
---
layout: documentation
---
:title: Muon Java
:date: 2015-01-05 11:40
:comments: true
:sharing: true
:source-highlighter: pygments
:toc: right
:toc-title: Muon Java
:toclevels: 6
:includedir: .
ifdef::env-doc[]
:includedir: submodules/java/doc
endif::[]
## Muon Java
Muon Java is the implementation of the Muon microservices toolkit, for the Java platform. Muon enables you to easily build
microservices in many languages that have richer, more performant and fully reactive communication semantics and gain access
to Muon compatible services written in other languages without having to sacrifice the rich semantics or performance.
.Contributing
****
Muon and the ecosystem services are open source.
Contribute to Muon Java and this documentation at http://github.com/muoncore/muon-java
****
include::{includedir}/core.adoc[leveloffset=+1]
include::{includedir}/eventsystem.adoc[leveloffset=+1]
include::{includedir}/spring.adoc[leveloffset=+1]
include::{includedir}/extension.adoc[leveloffset=+1]
``` |
969eb3a9-0910-4598-9fbc-e8f47af9b9a7 | {
"language": "AsciiDoc"
} | ```asciidoc
# Janitor - Keeping your Pocket clean since 2016
image:https://travis-ci.org/techdev-solutions/janitor.svg?branch=master["Build Status",link="https://travis-ci.org/techdev-solutions/janitor"]
An application to perform cleanup work using the https://getpocket.com[Pocket API].
## API Documentation
The documentation for the Kotlin API bindings can be found https://techdev-solutions.github.io/janitor/pocket-api/[here].```
Move Travis CI badge again | ```asciidoc
# Janitor image:https://travis-ci.org/techdev-solutions/janitor.svg?branch=master["Build Status",link="https://travis-ci.org/techdev-solutions/janitor"]
An application to perform cleanup work using the https://getpocket.com[Pocket API].
## API Documentation
The documentation for the Kotlin API bindings can be found https://techdev-solutions.github.io/janitor/pocket-api/[here].``` |
7ee4daf9-d7f5-433f-b982-5c8d139e6f21 | {
"language": "AsciiDoc"
} | ```asciidoc
[[breaking-changes]]
= Breaking changes
[partintro]
--
This section discusses the changes that you need to be aware of when migrating
your application from one version of Elasticsearch to another.
As a general rule:
* Migration between major versions -- e.g. `1.x` to `2.x` --
requires a <<restart-upgrade,full cluster restart>>.
* Migration between minor versions -- e.g. `1.x` to `1.y` -- can be
performed by <<rolling-upgrades,upgrading one node at a time>>.
See <<setup-upgrade>> for more info.
--
include::migrate_5_0.asciidoc[]
include::migrate_2_3.asciidoc[]
include::migrate_2_2.asciidoc[]
include::migrate_2_1.asciidoc[]
include::migrate_2_0.asciidoc[]
include::migrate_1_6.asciidoc[]
include::migrate_1_4.asciidoc[]
include::migrate_1_0.asciidoc[]
```
Remove links to nonexistent migration docs | ```asciidoc
[[breaking-changes]]
= Breaking changes
[partintro]
--
This section discusses the changes that you need to be aware of when migrating
your application from one version of Elasticsearch to another.
As a general rule:
* Migration between major versions -- e.g. `1.x` to `2.x` --
requires a <<restart-upgrade,full cluster restart>>.
* Migration between minor versions -- e.g. `1.x` to `1.y` -- can be
performed by <<rolling-upgrades,upgrading one node at a time>>.
See <<setup-upgrade>> for more info.
--
include::migrate_5_0.asciidoc[]
``` |
84408689-1001-4734-97b0-c786829537d1 | {
"language": "AsciiDoc"
} | ```asciidoc
[[indices-get-mapping]]
== Get Mapping
The get mapping API allows to retrieve mapping definitions for an index or
index/type.
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/twitter/_mapping/tweet'
--------------------------------------------------
[float]
=== Multiple Indices and Types
The get mapping API can be used to get more than one index or type
mapping with a single call. General usage of the API follows the
following syntax: `host:port/{index}/{type}/_mapping` where both
`{index}` and `{type}` can accept a comma-separated list of names. To
get mappings for all indices you can use `_all` for `{index}`. The
following are some examples:
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/_mapping/twitter,kimchy'
curl -XGET 'http://localhost:9200/_all/_mapping/tweet,book'
--------------------------------------------------
If you want to get mappings of all indices and types then the following
two examples are equivalent:
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/_all/_mapping'
curl -XGET 'http://localhost:9200/_mapping'
--------------------------------------------------
```
Update to the new {index}/_mapping/{type} format | ```asciidoc
[[indices-get-mapping]]
== Get Mapping
The get mapping API allows to retrieve mapping definitions for an index or
index/type.
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/twitter/_mapping/tweet'
--------------------------------------------------
[float]
=== Multiple Indices and Types
The get mapping API can be used to get more than one index or type
mapping with a single call. General usage of the API follows the
following syntax: `host:port/{index}/_mapping/{type}` where both
`{index}` and `{type}` can accept a comma-separated list of names. To
get mappings for all indices you can use `_all` for `{index}`. The
following are some examples:
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/_mapping/twitter,kimchy'
curl -XGET 'http://localhost:9200/_all/_mapping/tweet,book'
--------------------------------------------------
If you want to get mappings of all indices and types then the following
two examples are equivalent:
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/_all/_mapping'
curl -XGET 'http://localhost:9200/_mapping'
--------------------------------------------------
``` |
e9ce566d-f28e-487d-90db-ea4139aa40f8 | {
"language": "AsciiDoc"
} | ```asciidoc
= virtualreality
:author:
:revnumber:
:revdate: 2016/03/17 20:48
:relfileprefix: ../
:imagesdir: ..
ifdef::env-github,env-browser[:outfilesuffix: .adoc]
== OpenCV
== JavaCV
== Hand gesture links:
link:http://www.movesinstitute.org/~kolsch/HandVu/HandVu.html[http://www.movesinstitute.org/~kolsch/HandVu/HandVu.html]
```
Update the VR page to something more recent | ```asciidoc
= virtualreality
:author:
:revnumber:
:revdate: 2016/10/23 11:22
:relfileprefix: ../
:imagesdir: ..
ifdef::env-github,env-browser[:outfilesuffix: .adoc]
jMonkeyEngine 3 has a wide range of support for Virtual Reality (VR). The known supported systems are:
HTC Vive and systems supporting SteamVR/OpenVR
Razer HDK and systems supporting OSVR
Google Cardboard / GoogleVR
Legacy: Oculus Rift 0.5
In any form of VR, a library is needed as support is not built in to the core of jMonkeyEngine3.
== jMonkeyVR (https://github.com/phr00t/jMonkeyVR)
This is the main library to use when you want wide VR support. It has full OpenVR/SteamVR support and OSVR support in the making (as of Oct 2016)
== jme3-osvr (https://github.com/neph1/jme3-osvr)
Together with https://github.com/neph1/OSVR-Java provides rudimentary OSVR support (extended mode). Examples: https://github.com/neph1/jme3-osvr-examples
== gvr-android-jme (https://github.com/nordfalk/gvr-android-jme)
Google Cardboard VR SDK 1.0 integration
``` |
8d9abe75-5d24-4cdf-aa10-3518972d65e2 | {
"language": "AsciiDoc"
} | ```asciidoc
[[breaking-changes-5.5]]
== Breaking changes in 5.5
[[breaking_55_plugins]]
[float]
=== Ignoring hidden folders
Previous versions of Elasticsearch would skip hidden files and directories when
scanning the plugins folder. This allows broken plugin installs to remain
undetected so this leniency has been removed.
[[breaking_55_packaging_changes]]
[float]
=== Skip setting kernel parameters
Elasticsearch attempts to set the kernel parameter `vm.max_map_count` during
installation. In some environments this can fail. Previous versions of
Elasticsearch accepted a flag `ES_SKIP_SET_KERNEL_PARAMTERS` to skip this
writing. Starting in Elasticsearch 5.5.0, this flag has been removed and
instead the same functionality can be achieved by masking the `systemd-sysctl`
service.
```
Add migration note on get alias and get mapping APIs | ```asciidoc
[[breaking-changes-5.5]]
== Breaking changes in 5.5
[[breaking_55_plugins]]
[float]
=== Ignoring hidden folders
Previous versions of Elasticsearch would skip hidden files and directories when
scanning the plugins folder. This allows broken plugin installs to remain
undetected so this leniency has been removed.
[[breaking_55_packaging_changes]]
[float]
=== Skip setting kernel parameters
Elasticsearch attempts to set the kernel parameter `vm.max_map_count` during
installation. In some environments this can fail. Previous versions of
Elasticsearch accepted a flag `ES_SKIP_SET_KERNEL_PARAMTERS` to skip this
writing. Starting in Elasticsearch 5.5.0, this flag has been removed and
instead the same functionality can be achieved by masking the `systemd-sysctl`
service.
[[breaking_55_rest_changes]]
[float]
=== 404s on get alias and get mapping APIs
Previous versions of Elasticsearch did not return a 404 in all cases when a
requested alias or a requested type did not exist on the get alias or get
mapping APIs, respectively. Starting in Elasticsearch 5.5.0, these APIs
consistently return a 404 in any case when an alias or type is requested that
does not exist.
``` |
d24e7288-9775-43fd-b1a5-b333879e856a | {
"language": "AsciiDoc"
} | ```asciidoc
[[breaking-changes-6.2]]
== Breaking changes in 6.2
[[breaking_62_packaging]]
[float]
=== All permission bootstrap check
Elasticsearch installs a security manager during bootstrap to mitigate the scope
of exploits in the JDK, in third-party dependencies, and in Elasticsearch itself
as well as to sandbox untrusted plugins. A custom security policy can be applied
and one permission that can be added to this policy is
`java.security.AllPermission`. However, this effectively disables the security
manager. As such, granting this permission in production mode is now forbidden
via the <<all-permission-check, all permission bootstrap check>>.
```
Add migration note on private temporary directory | ```asciidoc
[[breaking-changes-6.2]]
== Breaking changes in 6.2
[[breaking_62_packaging]]
[float]
=== All permission bootstrap check
Elasticsearch installs a security manager during bootstrap to mitigate the scope
of exploits in the JDK, in third-party dependencies, and in Elasticsearch itself
as well as to sandbox untrusted plugins. A custom security policy can be applied
and one permission that can be added to this policy is
`java.security.AllPermission`. However, this effectively disables the security
manager. As such, granting this permission in production mode is now forbidden
via the <<all-permission-check, all permission bootstrap check>>.
=== Private temporary directory
On Linux, previous versions of Elasticsearch defaulted to using `/tmp` as the
temporary directory for the process. However, `/tmp` is public so we have
elected to change the packaging so that we use a private temporary directory. If
you are upgrading from a previous version of Elasticsearch and preserve your
existing <<jvm-options,`jvm.options`>>, you should add the line
`-Djava.io.tmpdir=${ES_TMPDIR}`. It is safe to do this on all OS as we preserve
using a private temporary directory on non-Linux systems with the same
mechanism.
``` |
69e7b8d1-b895-45d9-ab1b-abf743bcc4f8 | {
"language": "AsciiDoc"
} | ```asciidoc
[[java-query-dsl-type-query]]
==== Type Query
deprecated[7.0.0, Types are being removed, prefer filtering on a field instead. For more information, please see <<removal-of-types>>.]
See {ref}/query-dsl-type-query.html[Type Query]
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{query-dsl-test}[type]
--------------------------------------------------
<1> type
```
Fix a broken reference to types removal in the Java API docs. | ```asciidoc
[[java-query-dsl-type-query]]
==== Type Query
deprecated[7.0.0, Types are being removed, prefer filtering on a field instead. For more information, please see {ref}/removal-of-types.html[Removal of mapping types].]
See {ref}/query-dsl-type-query.html[Type Query]
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{query-dsl-test}[type]
--------------------------------------------------
<1> type
``` |
bf669a84-d6f5-4169-bcd7-ae52b2230353 | {
"language": "AsciiDoc"
} | ```asciidoc
= Explorer for Hawkular
http://hawkular.org/[Hawkular] is a set of components for Monitoring.
This explorer connects to a Hawkular server and allows to browse trough
inventory and view entities, graph metrics.
.Main screen with availability pop-up
ifndef::env-github[]
image::docs/screenshot.png[]
endif::[]
ifdef::env-github[]
image::https://github.com/pilhuhn/hawkfx/blob/master/docs/screenshot.png[]
endif::[]
Other functions include listing of all metrics on a system, listing of Events/Alerts, injection of Events,
injection of metric values and a few more things.
.Events list
ifndef::env-github[]
image::docs/event_list.png[]
endif::[]
ifdef::env-github[]
image::https://github.com/pilhuhn/hawkfx/blob/master/docs/event_list.png[]
endif::[]
== Running
The explorer requires JRuby in version 9+ and Java8
If you are using `rvm` you can select it via
`rvm use jruby-9.1.5.0`
install and use `bundler` to install the required gems
`gem install bundler`
`bundle install`
then run
`jruby -S -G hawkfx.rb````
Add a blurb about SSL setup | ```asciidoc
= Explorer for Hawkular
http://hawkular.org/[Hawkular] is a set of components for Monitoring.
This explorer connects to a Hawkular server and allows to browse trough
inventory and view entities, graph metrics.
.Main screen with availability pop-up
ifndef::env-github[]
image::docs/screenshot.png[]
endif::[]
ifdef::env-github[]
image::https://github.com/pilhuhn/hawkfx/blob/master/docs/screenshot.png[]
endif::[]
Other functions include listing of all metrics on a system, listing of Events/Alerts, injection of Events,
injection of metric values and a few more things.
.Events list
ifndef::env-github[]
image::docs/event_list.png[]
endif::[]
ifdef::env-github[]
image::https://github.com/pilhuhn/hawkfx/blob/master/docs/event_list.png[]
endif::[]
== Running
The explorer requires JRuby in version 9+ and Java8
If you are using `rvm` you can select it via
`rvm use jruby-9.1.5.0`
install and use `bundler` to install the required gems
`gem install bundler`
`bundle install`
then run
`jruby -S -G hawkfx.rb`
=== Using SSL
There is a blog post on the Hawkular
blog http://www.hawkular.org/blog/2016/09/14/consuming-hawkular-api-over-ssl.html[that describes how to use SSL] in Hawkular and HawkFX.``` |
31137b09-1e2a-4f49-9c80-916e8c916e7d | {
"language": "AsciiDoc"
} | ```asciidoc
= jediterm-forge
Provides https://github.com/forge/core/[JBoss Forge] console component based on
https://github.com/JetBrains/jediterm[JediTerm] for Swing applications, like IntelliJ, NetBeans,
or standalone shell client.
== Build
* Clone this JediTerm repository fork:
** `git clone https://github.com/adamwy/jediterm.git`
** `git checkout 2.0`
* Build default JediTerm target with http://ant.apache.org/bindownload.cgi[Apache Ant]:
** `ant`
* Install JediTerm as Maven artifact:
** `./install-jediterm-artifact "jediterm/build/jediterm-terminal-2.0.jar"`
* Build and install this project to local Maven repository:
** `mvn clean install`
```
Remove JediTerm build instruction (since terminal jar is provided in repository) | ```asciidoc
= jediterm-forge
Provides https://github.com/forge/core/[JBoss Forge] console component based on
https://github.com/JetBrains/jediterm[JediTerm] for Swing applications, like IntelliJ, NetBeans,
or standalone shell client.
== Build
* Clone this JediTerm repository fork:
** `git clone https://github.com/adamwy/jediterm.git`
** `git checkout 2.0`
* Install JediTerm as Maven artifact:
** `./install-jediterm-artifact "jediterm/build/jediterm-terminal-2.0.jar"`
* Build and install this project to local Maven repository:
** `mvn clean install`
``` |
e0ca3a3a-5cb1-47ba-9ec3-0f7282817c8b | {
"language": "AsciiDoc"
} | ```asciidoc
// Module included in the following assemblies:
//
// * logging/cluster-logging-kibana-interface.adoc
[id="cluster-logging-kibana-interface-launch_{context}"]
= Launching Kibana
Kibana is a browser-based console to query, discover, and visualize your logs through histograms, line graphs,
pie charts, heat maps, built-in geospatial support, and other visualizations.
.Procedure
To launch Kibana:
. In the {product-title} console, click *Monitoring* -> *Logging*.
. Log in using the same credentials you use to log in to the {product-title} console.
+
The Kibana interface launches. You can now:
+
* Search and browse your data using the Discover page.
* Chart and map your data using the Visualize page.
* Create and view custom dashboards using the Dashboard page.
+
Use and configuration of the Kibana interface is beyond the scope of this documentation. For more information,
on using the interface, see the link:https://www.elastic.co/guide/en/kibana/5.6/connect-to-elasticsearch.html[Kibana documentation].
```
Add note on Kibana OAuth refresh | ```asciidoc
// Module included in the following assemblies:
//
// * logging/cluster-logging-kibana-interface.adoc
[id="cluster-logging-kibana-interface-launch_{context}"]
= Launching Kibana
Kibana is a browser-based console to query, discover, and visualize your logs through histograms, line graphs,
pie charts, heat maps, built-in geospatial support, and other visualizations.
.Procedure
To launch Kibana:
. In the {product-title} console, click *Monitoring* -> *Logging*.
. Log in using the same credentials you use to log in to the {product-title} console.
+
The Kibana interface launches. You can now:
+
* Search and browse your data using the Discover page.
* Chart and map your data using the Visualize page.
* Create and view custom dashboards using the Dashboard page.
+
Use and configuration of the Kibana interface is beyond the scope of this documentation. For more information,
on using the interface, see the link:https://www.elastic.co/guide/en/kibana/5.6/connect-to-elasticsearch.html[Kibana documentation].
[NOTE]
====
If you get a *security_exception* error in the Kibana console and cannot access your Kibana indices, you might have an expired OAuth token. If you see this error, log out of the Kibana console, and then log back in. This refreshes your OAuth tokens and you should be able to access your indices.
====
``` |
f64cdf21-e024-4b89-bdd7-810a293767b3 | {
"language": "AsciiDoc"
} | ```asciidoc
= Spring Boot and Two DataSources
This project demonstrates how to use two `DataSource` s with Spring Boot.
It utilizes:
* Spring Data https://github.com/spring-projects/spring-data-jpa[JPA] / https://github.com/spring-projects/spring-data-rest[REST]
* https://github.com/flyway/flyway[Flyway] migrations for the two `DataSource` s
* Separate Hibernate properties for each `DataSource` defined in the application.yml
* https://github.com/thymeleaf/thymeleaf[Thymeleaf] 3
* https://github.com/DataTables/DataTablesSrc[DataTables]
* Unit tests for components```
Add note about potential slow hosted app startup | ```asciidoc
= Spring Boot and Two DataSources
This project demonstrates how to use two `DataSource` s with Spring Boot.
It utilizes:
* Spring Data https://github.com/spring-projects/spring-data-jpa[JPA] / https://github.com/spring-projects/spring-data-rest[REST]
* https://github.com/flyway/flyway[Flyway] migrations for the two `DataSource` s
* Separate Hibernate properties for each `DataSource` defined in the application.yml
* https://github.com/thymeleaf/thymeleaf[Thymeleaf] 3
* https://github.com/DataTables/DataTablesSrc[DataTables]
* Unit tests for components
Note: It may take a few seconds for the app to start if no one has not accessed it recently``` |
502e3714-5b9b-4803-b73b-a7aeed43f55d | {
"language": "AsciiDoc"
} | ```asciidoc
== asciidoctor-fopub-embed-svg-example
An example for embedding SVG images in an asciidoctor document.
=== Setup
----
bundle install
----
=== How to make the target pdf file
Running the command below make the target pdf file named "class_diagram.pdf" out of "class_diagram.adoc"
----
bundle exec rake
----
=== Watch *.adoc files
Running the command below, rake watches "\*.adoc" files and build "*.adoc" files whenever they are modified.
----
bundle exec rake watch
----
```
Add links for example output files | ```asciidoc
== asciidoctor-fopub-embed-svg-example
An example for embedding SVG images in an asciidoctor document.
=== Setup
----
bundle install
----
=== How to make the target pdf file
Running the command below make the target pdf file named "class_diagram.pdf" out of "class_diagram.adoc"
----
bundle exec rake
----
=== Watch *.adoc files
Running the command below, rake watches "\*.adoc" files and build "*.adoc" files whenever they are modified.
----
bundle exec rake watch
----
=== Example output files
You can see the example output files at
* https://hnakamur.github.io/asciidoctor-fopub-embed-svg-example/class_diagram.pdf[class_diagram.pdf]
* https://hnakamur.github.io/asciidoctor-fopub-embed-svg-example/class_diagram.html[class_diagram.html]
``` |
77cd1a75-0a4e-4d62-967b-a6eea69d1bde | {
"language": "AsciiDoc"
} | ```asciidoc
[[search-request-from-size]]
=== From / Size
Pagination of results can be done by using the `from` and `size`
parameters. The `from` parameter defines the offset from the first
result you want to fetch. The `size` parameter allows you to configure
the maximum amount of hits to be returned.
Though `from` and `size` can be set as request parameters, they can also
be set within the search body. `from` defaults to `0`, and `size`
defaults to `10`.
[source,js]
--------------------------------------------------
{
"from" : 0, "size" : 10,
"query" : {
"term" : { "user" : "kimchy" }
}
}
--------------------------------------------------
Note that `from` + `size` can not be more than the `index.max_result_window`
index setting which defaults to 10,000. See the <<search-request-scroll,Scroll>> or <<search-request-search-after,Search After>>
API for more efficient ways to do deep scrolling.
```
Add CONSOLE to from/size docs | ```asciidoc
[[search-request-from-size]]
=== From / Size
Pagination of results can be done by using the `from` and `size`
parameters. The `from` parameter defines the offset from the first
result you want to fetch. The `size` parameter allows you to configure
the maximum amount of hits to be returned.
Though `from` and `size` can be set as request parameters, they can also
be set within the search body. `from` defaults to `0`, and `size`
defaults to `10`.
[source,js]
--------------------------------------------------
GET /_search
{
"from" : 0, "size" : 10,
"query" : {
"term" : { "user" : "kimchy" }
}
}
--------------------------------------------------
// CONSOLE
Note that `from` + `size` can not be more than the `index.max_result_window`
index setting which defaults to 10,000. See the <<search-request-scroll,Scroll>> or <<search-request-search-after,Search After>>
API for more efficient ways to do deep scrolling.
``` |
961022fe-2e0a-40fb-8a62-e1cd9e085b06 | {
"language": "AsciiDoc"
} | ```asciidoc
= griffon-configuration-plugin
:linkattrs:
:project-name: griffon-configuration-plugin
image:http://img.shields.io/travis/griffon-plugins/{project-name}/master.svg["Build Status", link="https://travis-ci.org/griffon-plugins/{project-name}"]
image:http://img.shields.io/coveralls/griffon-plugins/{project-name}/master.svg["Coverage Status", link="https://coveralls.io/r/griffon-plugins/{project-name}"]
image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"]
image:https://api.bintray.com/packages/griffon/griffon-plugins/{project-name}/images/download.svg[link="https://bintray.com/griffon/griffon-plugins/{project-name}/_latestVersion"]
---
Provides additional configuration formats such as YAML and JSON.
Refer to the link:http://griffon-plugins.github.io/griffon-configuration-plugin/[plugin guide, window="_blank"] for
further information on configuration and usage.
```
Add Patreon badge to readme | ```asciidoc
= griffon-configuration-plugin
:linkattrs:
:project-name: griffon-configuration-plugin
image:http://img.shields.io/travis/griffon-plugins/{project-name}/master.svg["Build Status", link="https://travis-ci.org/griffon-plugins/{project-name}"]
image:http://img.shields.io/coveralls/griffon-plugins/{project-name}/master.svg["Coverage Status", link="https://coveralls.io/r/griffon-plugins/{project-name}"]
image:http://img.shields.io/badge/license-ASF2-blue.svg["Apache License 2", link="http://www.apache.org/licenses/LICENSE-2.0.txt"]
image:https://api.bintray.com/packages/griffon/griffon-plugins/{project-name}/images/download.svg[link="https://bintray.com/griffon/griffon-plugins/{project-name}/_latestVersion"]
---
image:https://img.shields.io/gitter/room/griffon/griffon.js.svg[link="https://gitter.im/griffon/griffon]
image:https://img.shields.io/badge/donations-Patreon-orange.svg[https://www.patreon.com/user?u=6609318]
---
Provides additional configuration formats such as YAML and JSON.
Refer to the link:http://griffon-plugins.github.io/griffon-configuration-plugin/[plugin guide, window="_blank"] for
further information on configuration and usage.
``` |
c7cd2557-75ea-45e3-b91f-e93b81a20c2b | {
"language": "AsciiDoc"
} | ```asciidoc
= Opal Runtime for Node.js
ifdef::env-github[]
image:https://img.shields.io/travis/mogztter/opal-runtime/master.svg[Travis build status, link=https://travis-ci.org/mogztter/opal-runtime]
image:http://img.shields.io/npm/v/opal-runtime.svg[npm version, link=https://www.npmjs.org/package/opal-runtime]
endif::[]
== Usage
```javascript
var Opal = require('opal-runtime').Opal;
// Now let's have fun with Opal!
```
```
Upgrade Travis build status badge | ```asciidoc
= Opal Runtime for Node.js
ifdef::env-github[]
image:https://img.shields.io/travis/Mogztter/opal-node-runtime/master.svg[Travis build status, link=https://travis-ci.org/Mogztter/opal-node-runtime]
image:http://img.shields.io/npm/v/opal-runtime.svg[npm version, link=https://www.npmjs.org/package/opal-runtime]
endif::[]
== Usage
```javascript
var Opal = require('opal-runtime').Opal;
// Now let's have fun with Opal!
```
``` |
b5b054d9-e296-4954-b0d6-02df73088942 | {
"language": "AsciiDoc"
} | ```asciidoc
= flexy-pool
Author <[email protected]>
v1.0.0, 2014-02-25
:homepage: http://vladmihalcea.com/
== Introduction
The flexy-pool library brings adaptability to a given Connection Pool, allowing it to resize on demand.
This is very handy since most connection pools offer a limited set of dynamic configuration strategies.
== Features
* extensive connection pool support
** http://docs.codehaus.org/display/BTM/Home[Bitronix Transaction Manager]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP2]
** http://www.mchange.com/projects/c3p0/[C3P0]
** http://jolbox.com/[BoneCP]
** http://brettwooldridge.github.io/HikariCP/[HikariCP]
* statistics support
** source connection acquiring time histogram
** total connection acquiring time histogram
** retries attempts histogram
** maximum CP size histogram
** connection request count histogram
** connection lease time histogram
== Documentation
. https://github.com/vladmihalcea/flexy-pool/wiki/Installation-Guide[Installation Guide]
. https://github.com/vladmihalcea/flexy-pool/wiki/User-Guide[User Guide]
IMPORTANT: Flexy Pool has not yet been released to OSS Maven Repository.
```
Add IMPORTANT section for Release status | ```asciidoc
= flexy-pool
Author <[email protected]>
v1.0.0, 2014-02-25
:homepage: http://vladmihalcea.com/
== Introduction
The flexy-pool library brings adaptability to a given Connection Pool, allowing it to resize on demand.
This is very handy since most connection pools offer a limited set of dynamic configuration strategies.
== Features
* extensive connection pool support
** http://docs.codehaus.org/display/BTM/Home[Bitronix Transaction Manager]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP2]
** http://www.mchange.com/projects/c3p0/[C3P0]
** http://jolbox.com/[BoneCP]
** http://brettwooldridge.github.io/HikariCP/[HikariCP]
* statistics support
** source connection acquiring time histogram
** total connection acquiring time histogram
** retries attempts histogram
** maximum CP size histogram
** connection request count histogram
** connection lease time histogram
== Documentation
. https://github.com/vladmihalcea/flexy-pool/wiki/Installation-Guide[Installation Guide]
. https://github.com/vladmihalcea/flexy-pool/wiki/User-Guide[User Guide]
[IMPORTANT]
Flexy Pool has not yet been released to OSS Maven Repository.
``` |
8b8df65c-f363-4054-ab4a-fc1f1b0b895e | {
"language": "AsciiDoc"
} | ```asciidoc
= Spring Boot, AngularJS 2, Kotlin demo
This is a demo which shows how to use Spring Boot, Spring Data JPA and AngularJS 2.
The demo is an implementation of Angular's Tour of Heroes tutorial. The demo is written in Kotlin and TypeScript.
The Heroes are stored in an in-memory H2 database. The H2 schema is managed by Flyway.
You can start the AngularJS 2 App and access it on `http://localhost:3000`:
`gradlew npmStartServer`
You can start the Spring Boot App and access it on `http://localhost:8090`:
`gradlew bootRun`
Webpack proxies the request from Angular2 to Spring Boot.
TODOs:
- [x] Implement Angular's Tour of Heroes tutorial
- Add Angular2 app as a static resource to the Spring Boot app
- Implement authentication/authorization with Spring Security and JWT Tokens
== Angular's Tour of Heroes
image:docs/tutorial.JPG[]
```
Add angular2-ui as a dependency to spring-boot-server | ```asciidoc
= Spring Boot, AngularJS 2, Kotlin demo
This is a demo which shows how to use Spring Boot, Spring Data JPA and AngularJS 2.
The demo is an implementation of Angular's Tour of Heroes tutorial. The demo is written in Kotlin and TypeScript.
The Heroes are stored in an in-memory H2 database. The H2 schema is managed by Flyway.
You can start the Angular2 App and access it on `http://localhost:3000`:
`gradlew npmStartServer`
You can start the Spring Boot App and access it on `http://localhost:8090`:
`gradlew bootRun`
Webpack proxies the request from Angular2 to Spring Boot.
You can package the Spring Boot App and Angular2 App into one Jar file:
`gradlew build`
The Angular2 App is served as static content under `http://localhost:8090/index.html, when you start the application`:
`java -jar spring-boot-server-0.1.0.jar`
TODOs:
- [x] Implement Angular's Tour of Heroes tutorial
- Add Angular2 app as a static resource to the Spring Boot app
- Implement authentication/authorization with Spring Security and JWT Tokens
== Angular's Tour of Heroes
image:docs/tutorial.JPG[]
``` |
d036534b-5438-42e6-8a79-aba9ab4a24e4 | {
"language": "AsciiDoc"
} | ```asciidoc
= Flexy Pool
Author <[email protected]>
v1.0.0, 2014-02-25
:homepage: http://vladmihalcea.com/
== Introduction
The Flexy Pool library brings adaptability to a given Connection Pool, allowing it to resize on demand.
This is very handy since most connection pools offer a limited set of dynamic configuration strategies.
== Features
* extensive connection pool support
** http://docs.codehaus.org/display/BTM/Home[Bitronix Transaction Manager]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP2]
** http://www.mchange.com/projects/c3p0/[C3P0]
** http://jolbox.com/[BoneCP]
** http://brettwooldridge.github.io/HikariCP/[HikariCP]
* statistics support
** source connection acquiring time histogram
** total connection acquiring time histogram
** retries attempts histogram
** maximum CP size histogram
** connection request count histogram
** connection lease time histogram
== Documentation
. https://github.com/vladmihalcea/flexy-pool/wiki/Installation-Guide[Installation Guide]
. https://github.com/vladmihalcea/flexy-pool/wiki/User-Guide[User Guide]
```
Add Flexy Pool Architecture diagram | ```asciidoc
= Flexy Pool
Author <[email protected]>
v1.0.0, 2014-02-25
:homepage: http://vladmihalcea.com/
== Introduction
The Flexy Pool library brings adaptability to a given Connection Pool, allowing it to resize on demand.
This is very handy since most connection pools offer a limited set of dynamic configuration strategies.
image::https://raw.githubusercontent.com/wiki/vladmihalcea/flexy-pool/image/architecture/FlexyPoolArchitecture.gif[Flexy Pool Architecture]
== Features
* extensive connection pool support
** http://docs.codehaus.org/display/BTM/Home[Bitronix Transaction Manager]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP]
** http://commons.apache.org/proper/commons-dbcp/[Apache DBCP2]
** http://www.mchange.com/projects/c3p0/[C3P0]
** http://jolbox.com/[BoneCP]
** http://brettwooldridge.github.io/HikariCP/[HikariCP]
* statistics support
** source connection acquiring time histogram
** total connection acquiring time histogram
** retries attempts histogram
** maximum CP size histogram
** connection request count histogram
** connection lease time histogram
== Documentation
. https://github.com/vladmihalcea/flexy-pool/wiki/Installation-Guide[Installation Guide]
. https://github.com/vladmihalcea/flexy-pool/wiki/User-Guide[User Guide]
``` |
5fc16dd6-a4e9-4515-9f4c-f0073f92b089 | {
"language": "AsciiDoc"
} | ```asciidoc
// Module included in the following assemblies:
//
// * storage/persistent_storage/persistent-storage-nfs.adoc
[id="nfs-selinux_{context}"]
= SELinux
By default, SELinux does not allow writing from a Pod to a remote
NFS server. The NFS volume mounts correctly, but is read-only.
To enable writing to a remote NFS server, follow the below procedure.
.Prerequisites
* The `container-selinux` package must be installed. This package provides
the `virt_use_nfs` SELinux boolean.
.Procedure
* Enable the `virt_use_nfs` boolean using the following command.
The `-P` option makes this boolean persistent across reboots.
+
[source,terminal]
----
# setsebool -P virt_use_nfs 1
----
```
Fix ISSUE-23216 - add RHEL note | ```asciidoc
// Module included in the following assemblies:
//
// * storage/persistent_storage/persistent-storage-nfs.adoc
[id="nfs-selinux_{context}"]
= SELinux
{op-system-base-full} and {op-system-first} systems are configured to use SELinux on remote NFS servers by default.
For non-{op-system-base} and non-{op-system} systems, SELinux does not allow writing from a pod to a remote NFS server. The NFS volume mounts correctly but it is read-only. You will need to enable the correct SELinux permissions by using the following procedure.
.Prerequisites
* The `container-selinux` package must be installed. This package provides the `virt_use_nfs` SELinux boolean.
.Procedure
* Enable the `virt_use_nfs` boolean using the following command. The `-P` option makes this boolean persistent across reboots.
+
[source,terminal]
----
# setsebool -P virt_use_nfs 1
----
``` |
6f494197-1d5d-460a-94f5-aa0760c0b354 | {
"language": "AsciiDoc"
} | ```asciidoc
= Getting Started
Gary Brown
2015-04-21
:description: How to get started with Scribble
:jbake-type: page
:jbake-status: published
:icons: font
== Getting Started with Scribble.
----
module examples;
global protocol HelloWorld(role Me, role World) {
hello(Greetings) from Me to World;
choice at World {
goodMorning(Compliments) from World to Me;
} or {
goodAfternoon(Salutations) from World to Me;
}
}
----
A very simply example, but this illustrates the basic syntax for a hello world interaction, where a party performing the role Me sends a message of type Greetings to another party performing the role 'World', who subsequently makes a decision which determines which path of the choice will be followed, resulting in a GoodMorning or GoodAfternoon message being exchanged.
=== Working on Scribble source
If you are interested in building Scribble from source, then check out
link:/docs/dev/developer-guide.html[Development resources]
```
Add message types to example | ```asciidoc
= Getting Started
Gary Brown
2015-04-21
:description: How to get started with Scribble
:jbake-type: page
:jbake-status: published
:icons: font
== Getting Started with Scribble.
----
module example;
type <xsd> "{http://www.acme.com/types}Greetings" from "http://www.acme.com/types/Greetings.xsd" as Greetings;
type <xsd> "{http://www.acme.com/types}Compliments" from "http://www.acme.com/types/Compliments.xsd" as Compliments;
type <xsd> "{http://www.acme.com/types}Salutations" from "http://www.acme.com/types/Salutations.xsd" as Salutations;
global protocol HelloWorld(role Me, role World) {
hello(Greetings) from Me to World;
choice at World {
goodMorning(Compliments) from World to Me;
} or {
goodAfternoon(Salutations) from World to Me;
}
}
----
A very simply example, but this illustrates the basic syntax for a hello world interaction, where a party performing the role Me sends a message of type Greetings to another party performing the role 'World', who subsequently makes a decision which determines which path of the choice will be followed, resulting in a _goodMorning_ or _goodAfternoon_ message being exchanged.
=== Working on Scribble source
If you are interested in building Scribble from source, then check out
link:/docs/dev/developer-guide.html[Development resources]
``` |
b22f96f3-1416-4736-a0cf-0b0ac6c3d9e9 | {
"language": "AsciiDoc"
} | ```asciidoc
= Spring Cloud for Cloud Foundry
include::intro.adoc[]
The first time you use it the discovery client might be slow owing to
the fact that it has to get an access token from Cloud Foundry.
== Quickstart
include::quickstart.adoc[]
=== Single Sign On
NOTE: All of the OAuth2 SSO and resource server features moved to Spring Boot
in version 1.3. You can find documentation in the
http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/[Spring Boot user guide].
This project provides automatic binding from CloudFoundry service
credentials to the Spring Boot features. If you have a CloudFoundry
service called "sso", for instance, with credentials containing
"client_id", "client_secret" and "auth_domain", it will bind
automatically to the Spring OAuth2 client that you enable with
`@EnableOAuth2Sso` (from Spring Boot). The name of the service can be
parameterized using `spring.oauth2.sso.serviceId`.
```
Make it obvious the docs are about Discovery | ```asciidoc
= Spring Cloud for Cloud Foundry
include::intro.adoc[]
The first time you use it the discovery client might be slow owing to
the fact that it has to get an access token from Cloud Foundry.
== Discovery
include::quickstart.adoc[]
== Single Sign On
NOTE: All of the OAuth2 SSO and resource server features moved to Spring Boot
in version 1.3. You can find documentation in the
http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/[Spring Boot user guide].
This project provides automatic binding from CloudFoundry service
credentials to the Spring Boot features. If you have a CloudFoundry
service called "sso", for instance, with credentials containing
"client_id", "client_secret" and "auth_domain", it will bind
automatically to the Spring OAuth2 client that you enable with
`@EnableOAuth2Sso` (from Spring Boot). The name of the service can be
parameterized using `spring.oauth2.sso.serviceId`.
``` |
b73defa2-56ce-41fc-afef-277ab4f99cf7 | {
"language": "AsciiDoc"
} | ```asciidoc
= Minimal-J
Java - but small.
image::doc/frontends.png[]
Minimal-J applications are
* Responsive to use on every device
* Straight forward to specify and implement and therefore
* Easy to plan and manage
=== Idea
Business applications tend to get complex and complicated. Minimal-J prevents this by setting clear rules how an application should behave and how it should be implemented.
Minimal applications may not always look the same. But the UI concepts never change. There are no surprises for the user.
== Technical Features
* Independent of the used UI technology. Implementations for Web / Mobile / Desktop.
* ORM persistence layer for Maria DB or in memory DB. Transactions and Authorization supported.
* Small: The minimalj.jar is still < 1MB
* Very few dependencies
* Applications can run standalone (like SpringBoot)
== Documentation
* link:doc/user_guide/user_guide.adoc[Minimal user guide] User guide for Minimal-J applications.
* link:doc/topics.adoc[Tutorial and examples] Informations for developers.
* link:doc/release_notes.adoc[Release Notes]
== Hello World
How to implement Hello World in Minimal-J:
link:_includes/ex-video.adoc[]
video::0VHz7gv6TpA[youtube]
=== Contact
* Bruno Eberhard, mailto:[email protected][[email protected]] ```
Include Hello World Youtube video | ```asciidoc
= Minimal-J
Java - but small.
image::doc/frontends.png[]
Minimal-J applications are
* Responsive to use on every device
* Straight forward to specify and implement and therefore
* Easy to plan and manage
=== Idea
Business applications tend to get complex and complicated. Minimal-J prevents this by setting clear rules how an application should behave and how it should be implemented.
Minimal applications may not always look the same. But the UI concepts never change. There are no surprises for the user.
== Technical Features
* Independent of the used UI technology. Implementations for Web / Mobile / Desktop.
* ORM persistence layer for Maria DB or in memory DB. Transactions and Authorization supported.
* Small: The minimalj.jar is still < 1MB
* Very few dependencies
* Applications can run standalone (like SpringBoot)
== Documentation
* link:doc/user_guide/user_guide.adoc[Minimal user guide] User guide for Minimal-J applications.
* link:doc/topics.adoc[Tutorial and examples] Informations for developers.
* link:doc/release_notes.adoc[Release Notes]
== Hello World
link:http://www.youtube.com/watch?v=0VHz7gv6TpA[How to implement Hello World in Minimal-J]
=== Contact
* Bruno Eberhard, mailto:[email protected][[email protected]] ``` |
cd807f9f-9734-440b-a352-f6af29eef5ad | {
"language": "AsciiDoc"
} | ```asciidoc
[NOTE]
====
This technology is considered {extension-status}.
ifeval::["{extension-status}" == "experimental"]
In _experimental_ mode, early feedback is requested to mature the idea.
There is no guarantee of stability nor long term presence in the platform until the solution matures.
Feedback is welcome on our https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker].
endif::[]
ifeval::["{extension-status}" == "preview"]
In _preview_, backward compatibility and presence in the ecosystem is not guaranteed.
Specific improvements might require changing configuration or APIs, and plans to become _stable_ are under way.
Feedback is welcome on our https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker].
endif::[]
ifeval::["{extension-status}" == "stable"]
Being _stable_, backward compatibility and presence in the ecosystem are taken very seriously.
endif::[]
For a full list of possible statuses, check our https://quarkus.io/faq/#extension-status[FAQ entry].
====
```
Add `deprecated` to extension status note | ```asciidoc
[NOTE]
====
This technology is considered {extension-status}.
ifeval::["{extension-status}" == "experimental"]
In _experimental_ mode, early feedback is requested to mature the idea.
There is no guarantee of stability nor long term presence in the platform until the solution matures.
Feedback is welcome on our https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker].
endif::[]
ifeval::["{extension-status}" == "preview"]
In _preview_, backward compatibility and presence in the ecosystem is not guaranteed.
Specific improvements might require changing configuration or APIs, and plans to become _stable_ are under way.
Feedback is welcome on our https://groups.google.com/d/forum/quarkus-dev[mailing list] or as issues in our https://github.com/quarkusio/quarkus/issues[GitHub issue tracker].
endif::[]
ifeval::["{extension-status}" == "stable"]
Being _stable_, backward compatibility and presence in the ecosystem are taken very seriously.
endif::[]
ifeval::["{extension-status}" == "deprecated"]
Being _deprecated_ means that this extension is likely to be replaced or removed in a future version of Quarkus.
endif::[]
For a full list of possible statuses, check our https://quarkus.io/faq/#what-are-the-extension-statuses[FAQ entry].
====
``` |
307c9434-d77f-4a3e-a771-43e2c3b3e4ee | {
"language": "AsciiDoc"
} | ```asciidoc
== Spring Cloud Starters
include::intro.adoc[]
```
Add link to github in rendered docs | ```asciidoc
== Spring Cloud Starters
:github: https://github.com/spring-cloud/spring-cloud-starters
:githubmaster: {github}/tree/master
:docslink: {githubmaster}/docs/src/main/asciidoc
include::intro.adoc[]
include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing-docs.adoc[]
``` |
06da0c96-d80a-4bfe-8577-ec2508f28d13 | {
"language": "AsciiDoc"
} | ```asciidoc
[[rest-api-unique-indexes]]
== Unique Indexing ==
For uniqueness enforcements, there are two modes:
* URL Parameter `unique=get_or_create`: Create a new node/relationship and index it if no existing one can be found. If an existing node/relationship is found, discard the sent data and return the existing node/relationship.
* URL Parameter `unique=create_or_fail`: Create a new node/relationship if no existing one can be found in the index. If an existing node/relationship is found, return a conflict error.
For more information, see <<transactions-unique-nodes>>.
include::get-or-create-unique-node-(create).asciidoc[]
include::get-or-create-unique-node-(existing).asciidoc[]
include::create-a-unique-node-or-return-fail-(create).asciidoc[]
include::create-a-unique-node-or-return-fail-(fail).asciidoc[]
include::get-or-create-unique-relationship-(create).asciidoc[]
include::get-or-create-unique-relationship-(existing).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(create).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(fail).asciidoc[]
```
Add reference to unique constraints to unique index chapter. | ```asciidoc
[[rest-api-unique-indexes]]
== Unique Indexing ==
NOTE: As of Neo4j 2.0, unique constraints have been added. These make Neo4j enforce the uniqueness,
guaranteeing that uniqueness is maintained. See <<graphdb-neo4j-schema-constraints>> for details about this.
For uniqueness enforcements, there are two modes:
* URL Parameter `unique=get_or_create`: Create a new node/relationship and index it if no existing one can be found.
If an existing node/relationship is found, discard the sent data and return the existing node/relationship.
* URL Parameter `unique=create_or_fail`: Create a new node/relationship if no existing one can be found in the index.
If an existing node/relationship is found, return a conflict error.
For more information, see <<transactions-unique-nodes>>.
include::get-or-create-unique-node-(create).asciidoc[]
include::get-or-create-unique-node-(existing).asciidoc[]
include::create-a-unique-node-or-return-fail-(create).asciidoc[]
include::create-a-unique-node-or-return-fail-(fail).asciidoc[]
include::get-or-create-unique-relationship-(create).asciidoc[]
include::get-or-create-unique-relationship-(existing).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(create).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(fail).asciidoc[]
``` |
4c5a1752-4fcc-45ad-a178-c1e6c4ce7a2f | {
"language": "AsciiDoc"
} | ```asciidoc
// Module included in the following assemblies:
//
// * machine_management/applying_autoscaling.adoc
// * machine_management/creating-infrastructure-machinesets.adoc
// * machine_management/creating-machinesets.adoc
// * machine_management/deploying-machine-health-checks.adoc
// * machine_management/manually-scaling-machinesets.adoc
[IMPORTANT]
====
This process is not applicable to clusters that use user-provisioned
infrastructure. Because you manually provisioned your machines yourself, you
cannot use the advanced machine management and scaling capabilities
that an installer-provisioned infrastructure cluster offers.
====
```
Remove ipi/upi dichotomy for machine management capabilities | ```asciidoc
// Module included in the following assemblies:
//
// * machine_management/applying_autoscaling.adoc
// * machine_management/creating-infrastructure-machinesets.adoc
// * machine_management/creating-machinesets.adoc
// * machine_management/deploying-machine-health-checks.adoc
// * machine_management/manually-scaling-machinesets.adoc
[IMPORTANT]
====
This process is not applicable to clusters where you manually provisioned the machines yourself. You
can use the advanced machine management and scaling capabilities only in clusters where the machine API is operational.
====
``` |
e9dd5df7-194b-4bf2-82d4-708680df3acc | {
"language": "AsciiDoc"
} | ```asciidoc
== Using a pre-release version
Pre-release versions of `AsciidoctorJ` are published to oss.sonatype.org.
The exact location of the repository will be announced.
Final releases are released to both Maven Central.
Here's how to use a pre-release version in Maven:
[source, xml]
----
<repositories>
<repository>
<id>staging</id>
<url>https://oss.sonatype.org/content/repositories/orgasciidoctor-1234</url> <1>
<releases>
<enabled>true</enabled>
</releases>
</repository>
</repositories>
----
<1> The exact URL differs for every build
```
Fix doc filename instead of title shown in nav menu | ```asciidoc
= Using a pre-release version
Pre-release versions of `AsciidoctorJ` are published to oss.sonatype.org.
The exact location of the repository will be announced.
Final releases are released to both Maven Central.
Here's how to use a pre-release version in Maven:
[source, xml]
----
<repositories>
<repository>
<id>staging</id>
<url>https://oss.sonatype.org/content/repositories/orgasciidoctor-1234</url> <1>
<releases>
<enabled>true</enabled>
</releases>
</repository>
</repositories>
----
<1> The exact URL differs for every build
``` |
f8fd8517-9654-4b78-add5-131090f65ce5 | {
"language": "AsciiDoc"
} | ```asciidoc
= Gradle Docker Plugin User Guide & Examples
:uri-bmuschko-blog: https://bmuschko.com/blog
:uri-ghpages: https://bmuschko.github.io/gradle-docker-plugin
:uri-github: https://github.com/bmuschko/gradle-docker-plugin
:uri-gradle-docs: https://docs.gradle.org/current
include::00-intro.adoc[]
include::10-remote-api-plugin.adoc[]
include::20-java-application-plugin.adoc[]
include::30-spring-boot-application-plugin.adoc[]
include::40-changes.adoc[]```
Use version in API link | ```asciidoc
= Gradle Docker Plugin User Guide & Examples
:uri-bmuschko-blog: https://bmuschko.com/blog
:uri-ghpages: https://bmuschko.github.io/gradle-docker-plugin/{gradle-project-version}
:uri-github: https://github.com/bmuschko/gradle-docker-plugin
:uri-gradle-docs: https://docs.gradle.org/current
include::00-intro.adoc[]
include::10-remote-api-plugin.adoc[]
include::20-java-application-plugin.adoc[]
include::30-spring-boot-application-plugin.adoc[]
include::40-changes.adoc[]``` |
2a6eb250-7896-457d-9739-78562dec8b1d | {
"language": "AsciiDoc"
} | ```asciidoc
[[rest-api-unique-indexes]]
== Unique Indexes ==
For uniqueness enforcements, there are two modes:
* URL Parameter `unique=get_or_create`: Create a new node/relationship and index it if no existing one can be found. If an existing node/relationship is found, discard the sent data and return the existing node/relationship.
* URL Parameter `unique=create_or_fail`: Create a new node/relationship if no existing one can be found in the index. If an existing node/relationship is found, return a conflict error.
For more information, see <<transactions-unique-nodes>>.
include::get-or-create-unique-node-(create).asciidoc[]
include::get-or-create-unique-node-(existing).asciidoc[]
include::create-a-unique-node-or-return-fail-(create).asciidoc[]
include::create-a-unique-node-or-return-fail-(fail).asciidoc[]
include::get-or-create-unique-relationship-(create).asciidoc[]
include::get-or-create-unique-relationship-(existing).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(create).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(fail).asciidoc[]
```
Fix documentation bug for unique indexes in REST. | ```asciidoc
[[rest-api-unique-indexes]]
== Unique Indexes ==
For uniqueness enforcements, there are two modes:
* URL Parameter `uniqueness=get_or_create`: Create a new node/relationship and index it if no existing one can be found. If an existing node/relationship is found, discard the sent data and return the existing node/relationship.
* URL Parameter `uniqueness=create_or_fail`: Create a new node/relationship if no existing one can be found in the index. If an existing node/relationship is found, return a conflict error.
For more information, see <<transactions-unique-nodes>>.
include::get-or-create-unique-node-(create).asciidoc[]
include::get-or-create-unique-node-(existing).asciidoc[]
include::create-a-unique-node-or-return-fail-(create).asciidoc[]
include::create-a-unique-node-or-return-fail-(fail).asciidoc[]
include::get-or-create-unique-relationship-(create).asciidoc[]
include::get-or-create-unique-relationship-(existing).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(create).asciidoc[]
include::create-a-unique-relationship-or-return-fail-(fail).asciidoc[]
``` |
2396a361-84bf-4088-ad15-8a84e77abba5 | {
"language": "AsciiDoc"
} | ```asciidoc
= Breaking changes in 2.10
:page-sidebar: am_2_x_sidebar
:page-permalink: am/2.x/am_breaking_changes_2.10.html
:page-folder: am/installation-guide
:page-layout: am
== JAR Manifest file has changed
Starting from version 2.10.10, the Main-Class of the entry point of the runnable management and gateway application has changed due to typo error.
----
AM Management API
- <mainClass>io.gravitee.am.management.standalone.boostrap.Bootstrap</mainClass>
+ <mainClass>io.gravitee.am.management.standalone.bootstrap.Bootstrap</mainClass>
AM Gateway
- <mainClass>io.gravitee.am.gateway.boostrap.Bootstrap</mainClass>
+ <mainClass>io.gravitee.am.gateway.bootstrap.Bootstrap</mainClass>
----
It could have an impact if you are using your own custom build/launch script with command like `java -jar gravitee-am-*-bootstrap.jar`.
Be sure to test this scenario before going further in your production environment.
NOTE: There is no impact if you rely on the built-in gravitee(.bat) script.
```
Update breaking changes for docker images | ```asciidoc
= Breaking changes in 2.10
:page-sidebar: am_2_x_sidebar
:page-permalink: am/2.x/am_breaking_changes_2.10.html
:page-folder: am/installation-guide
:page-layout: am
== JAR Manifest file has changed
Starting from version 2.10.10, the Main-Class of the entry point of the runnable management and gateway application has changed due to typo error.
----
AM Management API
- <mainClass>io.gravitee.am.management.standalone.boostrap.Bootstrap</mainClass>
+ <mainClass>io.gravitee.am.management.standalone.bootstrap.Bootstrap</mainClass>
AM Gateway
- <mainClass>io.gravitee.am.gateway.boostrap.Bootstrap</mainClass>
+ <mainClass>io.gravitee.am.gateway.bootstrap.Bootstrap</mainClass>
----
It could have an impact if you are using your own custom build/launch script with command like `java -jar gravitee-am-*-bootstrap.jar`.
Be sure to test this scenario before going further in your production environment.
NOTE: There is no impact if you rely on the built-in gravitee(.bat) script.
== Docker images
All the UI based docker images (console) are now using HTTP port 8080 and HTTPS port 8443 by default to
avoid the need of a root account to use 80/443 to improve the security of our platform.``` |
2adfec54-8a02-4dff-9ccb-3dd10c739a42 | {
"language": "AsciiDoc"
} | ```asciidoc
[source, bash, subs=attributes+, role="primary asciidoc-tabs-sync-cli"]
.CLI
----
ifdef::build-additional-parameters[]
quarkus build --native -Dquarkus.native.container-build=true {build-additional-parameters}
endif::[]
ifndef::build-additional-parameters[]
quarkus build --native -Dquarkus.native.container-build=true
endif::[]
----
ifndef::devtools-no-maven[]
ifdef::devtools-wrapped[+]
[source, bash, subs=attributes+, role="secondary asciidoc-tabs-sync-maven"]
.Maven
----
ifdef::build-additional-parameters[]
./mvnw package -Dnative -Dquarkus.native.container-build=true {build-additional-parameters}
endif::[]
ifndef::build-additional-parameters[]
./mvnw package -Dnative -Dquarkus.native.container-build=true
endif::[]
----
endif::[]
ifndef::devtools-no-gradle[]
ifdef::devtools-wrapped[+]
[source, bash, subs=attributes+, role="secondary asciidoc-tabs-sync-gradle"]
.Gradle
----
ifdef::build-additional-parameters[]
./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true {build-additional-parameters}
endif::[]
ifndef::build-additional-parameters[]
./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true
endif::[]
----
endif::[]```
Improve doc for containerized native build | ```asciidoc
[source, bash, subs=attributes+, role="primary asciidoc-tabs-sync-cli"]
.CLI
----
ifdef::build-additional-parameters[]
quarkus build --native --no-tests -Dquarkus.native.container-build=true {build-additional-parameters}
endif::[]
ifndef::build-additional-parameters[]
quarkus build --native --no-tests -Dquarkus.native.container-build=true
endif::[]
# The --no-tests flag is required only on Windows and macOS.
----
ifndef::devtools-no-maven[]
ifdef::devtools-wrapped[+]
[source, bash, subs=attributes+, role="secondary asciidoc-tabs-sync-maven"]
.Maven
----
ifdef::build-additional-parameters[]
./mvnw package -Dnative -Dquarkus.native.container-build=true {build-additional-parameters}
endif::[]
ifndef::build-additional-parameters[]
./mvnw package -Dnative -Dquarkus.native.container-build=true
endif::[]
----
endif::[]
ifndef::devtools-no-gradle[]
ifdef::devtools-wrapped[+]
[source, bash, subs=attributes+, role="secondary asciidoc-tabs-sync-gradle"]
.Gradle
----
ifdef::build-additional-parameters[]
./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true {build-additional-parameters}
endif::[]
ifndef::build-additional-parameters[]
./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true
endif::[]
----
endif::[]``` |
102f8344-5be8-42bf-90b9-5225532b9889 | {
"language": "AsciiDoc"
} | ```asciidoc
== Rook - Sane, smart, fast, Clojure web services
image:http://clojars.org/io.aviso/rook/latest-version.svg[Clojars Project, link="http://clojars.org/io.aviso/rook"]
image:https://drone.io/github.com/AvisoNovate/rook/status.png[Build Status, link="https://drone.io/github.com/AvisoNovate/rook"]
Rook is a set of middleware and handlers to enable metadata-based routing for https://github.com/ring-clojure/ring[Ring] web applications.
The intention is to expose a Clojure _namespace_ as a web service _resource_; there's a default mapping of HTTP verbs
and paths to function names; these can be extended or overridden by metadata on the functions in the namespace.
The end result is that a compliant web service resource can be created in very little code.
Rook also supports Swagger 2.0: a detailed JSON description of your web service is generated directly from the functions and metadata.
Rook is available under the terms of the Apache Software License 2.0.
link:https://portal.aviso.io/#/document/open-source/rook/Current[Full Documentation]
```
Use correct Asciidoc headers (not Markdown) | ```asciidoc
## Rook - Sane, smart, fast, Clojure web services
image:http://clojars.org/io.aviso/rook/latest-version.svg[Clojars Project, link="http://clojars.org/io.aviso/rook"]
image:https://drone.io/github.com/AvisoNovate/rook/status.png[Build Status, link="https://drone.io/github.com/AvisoNovate/rook"]
Rook is a set of middleware and handlers to enable metadata-based routing for https://github.com/ring-clojure/ring[Ring] web applications.
The intention is to expose a Clojure _namespace_ as a web service _resource_; there's a default mapping of HTTP verbs
and paths to function names; these can be extended or overridden by metadata on the functions in the namespace.
The end result is that a compliant web service resource can be created in very little code.
Rook also supports Swagger 2.0: a detailed JSON description of your web service is generated directly from the functions and metadata.
Rook is available under the terms of the Apache Software License 2.0.
link:https://portal.aviso.io/#/document/open-source/rook/Current[Full Documentation]
``` |
7988d375-8c0c-457a-ab08-833069b22c41 | {
"language": "AsciiDoc"
} | ```asciidoc
[id="learn-about-ovn-kubernetes"]
= About the OVN-Kubernetes Pod network provider
include::modules/common-attributes.adoc[]
:context: learn-about-ovn-kubernetes
toc::[]
include::modules/nw-ovn-technology-preview.adoc[leveloffset=+1]
[id="ovn-kubernetes-metrics"]
== Exposed metrics
The OVN-Kubernetes network provider exposes certain metrics for use by the Prometheus-based {product-title} cluster monitoring stack.
// openshift/ovn-kubernetes => go-controller/pkg/ovn/metrics.go
.Metrics exposed by OVN-Kubernetes
[cols="2a,8a",options="header"]
|===
|Name |Description
|`nb_e2e_timestamp`
|A timestamp persisted to the Open vSwitch (OVN) northbound database and updated frequently.
|`pod_creation_latency_seconds`
|The latency between when a Pod is created and when the Pod is annotated by OVN-Kubernetes. The higher the latency, the more time that elapses before a Pod is available for network connectivity.
|===
```
Update the metric names for OVN-Kubernetes | ```asciidoc
[id="learn-about-ovn-kubernetes"]
= About the OVN-Kubernetes Pod network provider
include::modules/common-attributes.adoc[]
:context: learn-about-ovn-kubernetes
toc::[]
include::modules/nw-ovn-technology-preview.adoc[leveloffset=+1]
[id="ovn-kubernetes-metrics"]
== Exposed metrics
The OVN-Kubernetes network provider exposes certain metrics for use by the Prometheus-based {product-title} cluster monitoring stack.
// openshift/ovn-kubernetes => go-controller/pkg/ovn/metrics.go
.Metrics exposed by OVN-Kubernetes
[cols="2a,8a",options="header"]
|===
|Name |Description
|`ovnkube_master_nb_e2e_timestamp`
|A timestamp persisted to the Open vSwitch (OVN) northbound database and updated frequently.
|`ovnkube_master_pod_creation_latency_seconds`
|The latency between when a Pod is created and when the Pod is annotated by OVN-Kubernetes. The higher the latency, the more time that elapses before a Pod is available for network connectivity.
|===
``` |
abcf713c-b25c-4105-8287-4b2abe447a7a | {
"language": "AsciiDoc"
} | ```asciidoc
= Transform Query Parameters Policy
ifdef::env-github[]
image:https://ci.gravitee.io/buildStatus/icon?job=gravitee-io/gravitee-policy-transformqueryparams/master["Build status", link="https://ci.gravitee.io/job/gravitee-io/job/gravitee-policy-transformqueryparams/"]
image:https://badges.gitter.im/Join Chat.svg["Gitter", link="https://gitter.im/gravitee-io/gravitee-io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
endif::[]
== Phase
[cols="2*", options="header"]
|===
^|onRequest
^|onResponse
^.^| X
^.^|
|===
== Description
The Transform Query Parameters policy is used to override incoming request HTTP query parameters.
You can override these HTTP query parameters by:
* Clearing all existing query parameters
* Adding or updating list of query parameters
* Removing them individually
[source, json]
.Sample
----
"transform-queryparams": {
"addQueryParameters": [
{
"name": "myParam",
"value": "{#request.id}"
}
],
"removeQueryParameters": [
"secretParam"
]
}
----```
Document how to access incoming query parameters | ```asciidoc
= Transform Query Parameters Policy
ifdef::env-github[]
image:https://ci.gravitee.io/buildStatus/icon?job=gravitee-io/gravitee-policy-transformqueryparams/master["Build status", link="https://ci.gravitee.io/job/gravitee-io/job/gravitee-policy-transformqueryparams/"]
image:https://badges.gitter.im/Join Chat.svg["Gitter", link="https://gitter.im/gravitee-io/gravitee-io?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"]
endif::[]
== Phase
[cols="2*", options="header"]
|===
^|onRequest
^|onResponse
^.^| X
^.^|
|===
== Description
The Transform Query Parameters policy is used to override incoming request HTTP query parameters.
You can override these HTTP query parameters by:
* Clearing all existing query parameters
* Adding or updating list of query parameters
* Removing them individually
The values of query parameters of the incoming request are accessible via the `{#request.params['query_parameter_name']}` construct.
The example below shows how to add the ID of the incoming request to the outgoing request.
[source, json]
.Sample
----
"transform-queryparams": {
"addQueryParameters": [
{
"name": "myParam",
"value": "{#request.id}"
}
],
"removeQueryParameters": [
"secretParam"
]
}
----
``` |
41012e1b-0591-4b93-bb45-75d970d6d2ed | {
"language": "AsciiDoc"
} | ```asciidoc
# react-popover
:toc: macro
A specification backed popover for react
toc::[]
## Installation
----
npm install react-popover
----
## Examples
The `examples` folder contains basic applications of this component. To try them locally run `npm start`.
## API
TODO
```
Update readme with demo link | ```asciidoc
# react-popover
:toc: macro
A specification backed popover for react. See [demo](https://littlebits.github.io/react-popover/build).
toc::[]
## Installation
----
npm install react-popover
----
## Examples
The `examples` folder contains basic applications of this component. To try them locally run `npm start`.
## API
TODO
``` |
697a42da-97cc-4821-b1b5-64297e88c61e | {
"language": "AsciiDoc"
} | ```asciidoc
= OmniJ Developer's Guide
Sean Gilligan
v0.1, July 30, 2015: Early draft
:numbered:
:toc:
:toclevels: 3
:linkattrs:
:imagesdir: images
Paragraph TBD.
== Introduction to OmniJ
This section is TBD. For now the project http://github.com/OmniLayer/OmniJ/README.adoc[README] is the best place to get started.
== JSON-RPC Clients
[plantuml, diagram-classes, svg]
....
skinparam packageStyle Rect
skinparam shadowing false
hide empty members
namespace com.msgilligan.bitcoin.rpc {
class RPCClient
RPCClient <|-- class DynamicRPCClient << Groovy >>
RPCClient <|-- BitcoinClient
BitcoinClient <|-- class BitcoinCLIClient << Groovy >>
}
namespace foundation.omni.rpc {
com.msgilligan.bitcoin.rpc.BitcoinClient <|-- OmniClient
OmniClient <|-- OmniExtendedClient
OmniExtendedClient <|-- class OmniCLIClient << Groovy >>
}
....
```
Fix broken link to OmniJ Project README | ```asciidoc
= OmniJ Developer's Guide
Sean Gilligan
v0.1, July 30, 2015: Early draft
:numbered:
:toc:
:toclevels: 3
:linkattrs:
:imagesdir: images
Paragraph TBD.
== Introduction to OmniJ
This section is TBD. For now the project https://github.com/OmniLayer/OmniJ#omnij-project[README] is the best place to get started.
== JSON-RPC Clients
[plantuml, diagram-classes, svg]
....
skinparam packageStyle Rect
skinparam shadowing false
hide empty members
namespace com.msgilligan.bitcoin.rpc {
class RPCClient
RPCClient <|-- class DynamicRPCClient << Groovy >>
RPCClient <|-- BitcoinClient
BitcoinClient <|-- class BitcoinCLIClient << Groovy >>
}
namespace foundation.omni.rpc {
com.msgilligan.bitcoin.rpc.BitcoinClient <|-- OmniClient
OmniClient <|-- OmniExtendedClient
OmniExtendedClient <|-- class OmniCLIClient << Groovy >>
}
....
``` |
c88689b0-4808-45c8-b3ea-1f3d99ef787a | {
"language": "AsciiDoc"
} | ```asciidoc
= Internal glossary
This is not a document to be published outside.
This is a collection of preferred term in the documentation and website.
Please stay witin these terms for consistency.
Live reload:: for our `quarkus:dev` capability
GraalVM:: preferred term for the VM creating native executable. No space.
Substrate VM:: non-preferred. Only if you want to clarify which part of GraalVM we use.
Native Executable:: the executable that is compiled to native 1s and 0s
Docker image:: for the actual `Dockerfile` definition and when the tool chain is involved
Container:: when we discuss Quarkus running in... containers
Supersonic Subatomic Java:: our tagline
Kubernetes Native Java:: our preferred tagline to say that we rock for containers
Developer Joy:: for everything going from live reload to the opinionated layer to a single config file
Unify Imperative and Reactive:: imperative and reactive. 'Nuff said.
Best of breed frameworks and standards:: when we explain our stack
```
Make the glossary a bit better | ```asciidoc
= Internal glossary
This is not a document to be published outside.
This is a collection of preferred term in the documentation and website.
Please stay within these terms for consistency.
* Live reload:: for our `quarkus:dev` capability
* GraalVM:: preferred term for the VM creating native executable. No space.
* Substrate VM:: non-preferred. Only if you want to clarify which part of GraalVM we use.
* Native Executable:: the executable that is compiled to native 1s and 0s
* Docker image:: for the actual `Dockerfile` definition and when the tool chain is involved
* Container:: when we discuss Quarkus running in... containers
* Supersonic Subatomic Java:: our tagline
* Kubernetes Native Java:: our preferred tagline to say that we rock for containers
* Developer Joy:: for everything going from live reload to the opinionated layer to a single config file
* Unify Imperative and Reactive:: imperative and reactive. 'Nuff said.
* Best of breed frameworks and standards:: when we explain our stack
``` |
c830075c-71ee-4989-b510-577472bcfc22 | {
"language": "AsciiDoc"
} | ```asciidoc
[[documentation.upgrading]]
== Upgrading From an Earlier Version
You should always ensure that you are running a {github-wiki}/Supported-Versions[supported version] of Spring Boot.
Depending on the version that you are upgrading to, you can find some additional tips here:
* *From 1.x:* <<actuator#upgrading.from-1x, Upgrading from 1.x>>
* *To a new feature release:* <<upgrading#upgrading.to-feature, Upgrading to New Feature Release>>
* *Spring Boot CLI:* <<upgrading#upgrading.cli, Upgrading the Spring Boot CLI>>
```
Fix link to Upgrading From 1.x in multi-page documentation | ```asciidoc
[[documentation.upgrading]]
== Upgrading From an Earlier Version
You should always ensure that you are running a {github-wiki}/Supported-Versions[supported version] of Spring Boot.
Depending on the version that you are upgrading to, you can find some additional tips here:
* *From 1.x:* <<upgrading#upgrading.from-1x, Upgrading from 1.x>>
* *To a new feature release:* <<upgrading#upgrading.to-feature, Upgrading to New Feature Release>>
* *Spring Boot CLI:* <<upgrading#upgrading.cli, Upgrading the Spring Boot CLI>>
``` |
800b2ee3-244a-4a1f-b0c8-3c581d00d5e6 | {
"language": "AsciiDoc"
} | ```asciidoc
= Hashicorp Vault Component
:doctitle: Hashicorp Vault
:shortname: hashicorp-vault
:artifactid: camel-hashicorp-vault
:description: Manage secrets in Hashicorp Vault Service
:since: 3.18
:supportlevel: Preview
:component-header: Only producer is supported
//Manually maintained attributes
:group: Azure
:camel-spring-boot-name: hashicorp-vault
*Since Camel {since}*
*{component-header}*
The hashicorp-vault component that integrates https://www.vaultproject.io/[Hashicorp Vault].
== URI Format
[source,xml]
------------------------------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-hashicorp-vault</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
------------------------------------------------------------
// component-configure options: START
// component-configure options: END
// component options: START
include::partial$component-configure-options.adoc[]
include::partial$component-endpoint-options.adoc[]
// component options: END
// endpoint options: START
// endpoint options: END
```
Remove group azure as its not from azure | ```asciidoc
= Hashicorp Vault Component
:doctitle: Hashicorp Vault
:shortname: hashicorp-vault
:artifactid: camel-hashicorp-vault
:description: Manage secrets in Hashicorp Vault Service
:since: 3.18
:supportlevel: Preview
:component-header: Only producer is supported
//Manually maintained attributes
:camel-spring-boot-name: hashicorp-vault
*Since Camel {since}*
*{component-header}*
The hashicorp-vault component that integrates https://www.vaultproject.io/[Hashicorp Vault].
== URI Format
[source,xml]
------------------------------------------------------------
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-hashicorp-vault</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
------------------------------------------------------------
// component-configure options: START
// component-configure options: END
// component options: START
include::partial$component-configure-options.adoc[]
include::partial$component-endpoint-options.adoc[]
// component options: END
// endpoint options: START
// endpoint options: END
``` |
350b2851-03cb-4e3f-90b8-e80c791fbc73 | {
"language": "AsciiDoc"
} | ```asciidoc
= To-Do List
- mock_cone_detector creates infinite area and overflows h
- [line-through]#new waypoints shorter than old don't delete existing waypoints#
- adjust waypoints for start position and cone position
- cone area goes down when very close to cone
- [line-through]#parameterize throttle and steering PWM values#
- touch sensor does not work
- cone detection in bright light does not work
- GUIDED mode does not work
- Encode PWM values or range set to use in the waypoints file
- If waypoint encountered before cone is seen, rover goes into HOLD mode
with no recovery. Needs to be fixed.
== Possible To-Do
- [line-through]#Change from using WP_SPEED to CRUISE_SPEED. (Seems to be used by Vicky,
while WP_SPEED is not.)#
- Have a way of manually triggering parameter reload
== Notes
MAV_CMD_DO_SET_HOME appears to reset the map origin, as well as zero the
offset between the map origin and base_link (for /mavros/local_position/pose
and /mavros/local_position/odom).
```
Mark completed items as DONE instead of using line-through | ```asciidoc
= To-Do List
- mock_cone_detector creates infinite area and overflows h
- (*DONE*) new waypoints shorter than old don't delete existing waypoints
- adjust waypoints for start position and cone position
- cone area goes down when very close to cone
- (*DONE*) parameterize throttle and steering PWM values
- touch sensor does not work
- cone detection in bright light does not work
- GUIDED mode does not work
- Encode PWM values or range set to use in the waypoints file
- If waypoint encountered before cone is seen, rover goes into HOLD mode
with no recovery. Needs to be fixed.
== Possible To-Do
- (*DONE*) Change from using WP_SPEED to CRUISE_SPEED. (Seems to be used by Vicky,
while WP_SPEED is not.)
- Have a way of manually triggering parameter reload
== Notes
MAV_CMD_DO_SET_HOME appears to reset the map origin, as well as zero the
offset between the map origin and base_link (for /mavros/local_position/pose
and /mavros/local_position/odom).
``` |
c7b4cfa5-e631-4c1e-8d6d-740ed9a09c9c | {
"language": "AsciiDoc"
} | ```asciidoc
=== Get the Clusters that Have Command Available
==== Description
Search the clusters that the given command is linked to.
==== Endpoint
`GET /api/v3/applications/{id}/commands`
:snippet-base: {snippets}/command-rest-controller-integration-test/can-get-clusters-for-command/8
:id-base: get-clusters-for-command
:!request-headers:
:request-path-params: {snippet-base}/path-parameters.adoc
:request-query-params: {snippet-base}/request-parameters.adoc
:!request-fields:
:curl-request: {snippet-base}/curl-request.adoc
:httpie-request: {snippet-base}/httpie-request.adoc
:response-headers: {snippet-base}/response-headers.adoc
:response-fields: {snippet-base}/response-fields.adoc
:!response-links:
:http-request: {snippet-base}/http-request.adoc
:http-response: {snippet-base}/http-response.adoc
include::../_apiTemplate.adoc[]
```
Fix spelling error in endpoint | ```asciidoc
=== Get the Clusters that Have Command Available
==== Description
Search the clusters that the given command is linked to.
==== Endpoint
`GET /api/v3/commands/{id}/clusters`
:snippet-base: {snippets}/command-rest-controller-integration-test/can-get-clusters-for-command/8
:id-base: get-clusters-for-command
:!request-headers:
:request-path-params: {snippet-base}/path-parameters.adoc
:request-query-params: {snippet-base}/request-parameters.adoc
:!request-fields:
:curl-request: {snippet-base}/curl-request.adoc
:httpie-request: {snippet-base}/httpie-request.adoc
:response-headers: {snippet-base}/response-headers.adoc
:response-fields: {snippet-base}/response-fields.adoc
:!response-links:
:http-request: {snippet-base}/http-request.adoc
:http-response: {snippet-base}/http-response.adoc
include::../_apiTemplate.adoc[]
``` |
8d51a9e5-034c-4aeb-8877-27c4b54d003c | {
"language": "AsciiDoc"
} | ```asciidoc
= Changelog
== Version 0.3.0
Date: 2014-01-18
- First version splitted from monolitic buddy package.
- No changes from original version.
```
Update changelog related to jws changes. | ```asciidoc
= Changelog
== Version 0.4.0
Date: unreleased
- Add encode/decode functions to JWS/JWT implementation. Them instead of return
plain value, return a monadic either. That allows granular error reporting
instead something like nil that not very useful. The previous sign/unsign
are conserved for backward compatibility but maybe in future will be removed.
-
== Version 0.3.0
Date: 2014-01-18
- First version splitted from monolitic buddy package.
- No changes from original version.
``` |
ee9ea8f9-8a52-4c81-bb19-e0a8940e1ebb | {
"language": "AsciiDoc"
} | ```asciidoc
== dda - Django Desktop Application
=== Introduction
DDA is an example project to demonstrate how to use Django as a desktop
application. It provides an alternative to using a GUI framework such as
https://docs.python.org/3.4/library/tkinter.html[Tkinter] or
http://sourceforge.net/projects/pyqt/[PyQt].
It is a work in progress.
```
Add credits section for included content. | ```asciidoc
== dda - Django Desktop Application
=== Introduction
DDA is an example project to demonstrate how to use Django as a desktop
application. It provides an alternative to using a GUI framework such as
https://docs.python.org/3.4/library/tkinter.html[Tkinter] or
http://sourceforge.net/projects/pyqt/[PyQt].
It is a work in progress.
=== Credits
To allow the Django Desktop Application to access common javascript and css
files used by the web pages (without having to hit the network), I have
included copies in this distribution. Here is a list:
- http://jquery.com/[jQuery (Version 2.1.1)]
- http://getbootstrap.com/[Bootstrap (Version 3.3.1)]
- http://glyphicons.com/[Glyphicons] (Graciously donated to Bootstrap)
- http://silviomoreto.github.io/bootstrap-select/[Bootstrap Select (Version 1.6.3)]
They are all awesome.
``` |
024e53f4-873f-4d64-b675-2321499d14e7 | {
"language": "AsciiDoc"
} | ```asciidoc
= Creating an Uberjar
Edge provides a script for running pack to build an uberjar.
To use it, you can simply run the below from your project sub-directory (the same folder as your deps.edn).
[source,shell]
----
$ ../bin/onejar -A:prod --args '-m edge.main' project.jar
----
The `-A:prod` indicates an alias you would like to have its `:extra-deps` and `:paths` included in your resulting jar.
`--args` are default arguments to your jar, in this case we are specifying that the application should run edge.main, part of the edge production modules.
You can run this jar in production quite easily:
[source,shell]
----
$ java -Xmx1G -jar project.jar
----
We recommend that you specify the memory usage of your JVM, as the default on Java 6+ is usually insufficient for hosts run only this JVM process.
A rule of thumb is to use 2/3rds of the memory of your host.
```
Add docs for how to use the capsule command | ```asciidoc
= Creating an Uberjar
== OneJar
Edge provides a script for running pack to build an uberjar.
To use it, you can simply run the below from your project sub-directory (the same folder as your deps.edn).
[source,shell]
----
$ ../bin/onejar -A:prod --args '-m edge.main' project.jar
----
The `-A:prod` indicates an alias you would like to have its `:extra-deps` and `:paths` included in your resulting jar.
`--args` are default arguments to your jar, in this case we are specifying that the application should run edge.main, part of the edge production modules.
== Capsule
Build a capsule uberjar using this command:
[source,shell]
----
$ ../bin/capsule -m edge.main -e 'target/prod' -A:prod project.jar
----
If you are using clojurescript in your project make sure you run this command first:
[source,shell]
----
$ clojure -A:build:build/once
----
It will build the clojurescript files and put them in the correct folder to be included in the uberjar.
== Running the jar
You can run the produced jar in production quite easily:
[source,shell]
----
$ java -Xmx1G -jar project.jar
----
We recommend that you specify the memory usage of your JVM, as the default on Java 6+ is usually insufficient for hosts run only this JVM process.
A rule of thumb is to use 2/3rds of the memory of your host.
``` |
a443db01-c10e-417e-83ee-4a9c15a3be54 | {
"language": "AsciiDoc"
} | ```asciidoc
= Callfire API v2 REST client
C# client for Callfire platform API version 2. See link:https://developers.callfire.com/callfire-api-client-csharp.html[Getting Started]
page for setup instructions.
.*Requirements:*
* .NET 4.6+
.*Dependencies:*
* Newtonsoft.Json >= 7.0.1
* RestSharp >= 106.4.2
.*Table of contents*
* link:https://developers.callfire.com/callfire-api-client-csharp.html[Getting Started]
* link:https://developers.callfire.com/docs.html[REST endpoints documentation and api code samples]
* Have a question ?
** link:https://developers.callfire.com/chat.html[Public chat room]
** link:http://stackoverflow.com/questions/tagged/callfire[Ask on stackoverflow]
** link:https://answers.callfire.com/hc/en-us[Call Us]
```
Update readmy with dependency versions | ```asciidoc
= Callfire API v2 REST client
C# client for Callfire platform API version 2. See link:https://developers.callfire.com/callfire-api-client-csharp.html[Getting Started]
page for setup instructions.
.*Requirements:*
* .NET 4.6+
.*Dependencies:*
* Newtonsoft.Json >= 12.0.2
* RestSharp = 106.6.4 (RestSharp have a bug with serialization to camelCase json string, wait for fix https://github.com/restsharp/RestSharp/issues/1251 before upgrade to newer)
.*Table of contents*
* link:https://developers.callfire.com/callfire-api-client-csharp.html[Getting Started]
* link:https://developers.callfire.com/docs.html[REST endpoints documentation and api code samples]
* Have a question ?
** link:https://developers.callfire.com/chat.html[Public chat room]
** link:http://stackoverflow.com/questions/tagged/callfire[Ask on stackoverflow]
** link:https://answers.callfire.com/hc/en-us[Call Us]
``` |
043c937e-f340-4177-9878-1a2b300d2bce | {
"language": "AsciiDoc"
} | ```asciidoc
= Report an issue
:awestruct-layout: normalBase
:showtitle:
== Issue tracker
We welcome issue reports (bugs, improvements, new feature requests, ...) in our issue tracker:
*Show https://issues.jboss.org/browse/drools[the JIRA issue tracker].*
Log in and click on the button _Create Issue_ to report a bug, improvement or feature request.
== Pull requests on GitHub
Want to fix the issue yourself? Fork https://github.com/droolsjbpm[the git repository] and send in a pull request.
We usually process all pull requests within a few days.
== Kanban boards
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=4016[Drools]
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=3828[OptaPlanner]
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=3972[jBPM]
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=3462[Guvnor]
* AppFormer (todo)
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=3838[Designer.NEXT]
```
Update to OptaPlanner scrum board | ```asciidoc
= Report an issue
:awestruct-layout: normalBase
:showtitle:
== Issue tracker
We welcome issue reports (bugs, improvements, new feature requests, ...) in our issue tracker:
*Show https://issues.jboss.org/browse/drools[the JIRA issue tracker].*
Log in and click on the button _Create Issue_ to report a bug, improvement or feature request.
== Pull requests on GitHub
Want to fix the issue yourself? Fork https://github.com/droolsjbpm[the git repository] and send in a pull request.
We usually process all pull requests within a few days.
== Kanban boards
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=4016[Drools]
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=4032[OptaPlanner]
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=3972[jBPM]
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=3462[Guvnor]
* AppFormer (todo)
* https://issues.jboss.org/secure/RapidBoard.jspa?rapidView=3838[Designer.NEXT]
``` |
3a8135f4-c484-4016-8b95-1fe7070ca5a5 | {
"language": "AsciiDoc"
} | ```asciidoc
= Components
:page-sidebar: apim_sidebar
:page-permalink: apim_overview_components.html
:page-folder: apim/overview
Next sections are describing top components which are part of Gravitee.io.
== Gateway
The gateway is the core component of the Gravitee.io platform. You can compare it to a "smart" proxy to understand its goal.
Unlike traditional HTTP proxy, the gateway is able to apply <<apim_overview_plugins.adoc#gravitee-plugins-policies, policies>> (ie. rules) to
both HTTP requests and responses according to your needs, meaning that you can enhance requests and responses processing
by adding transformation, security, and many other crazy features!
.Gravitee.io - Gateway Internal
image::architecture/graviteeio-gateway-internal.png[Gravitee.io - Gateway Internal]
.Gravitee.io - Gateway Architecture
image::architecture/graviteeio-gateway-architecture.png[Gravitee.io - Gateway Architecture]
== Management API
A restful API providing a bunch of services to manage and configure the global platform. All exposed
services are constraint by authentication and authorization rules.
You can find more information by having a look to the <<gravitee-management-api-overview, Management API>> section.
== Management UI
This is the Web UI for <<gravitee-components-mgmt-api, Gravitee.io Management API>>. This UI acts as a management tool
for API Publishers but also as a portal for your API Consumers.
```
Fix the documentation of REST API link | ```asciidoc
= Components
:page-sidebar: apim_sidebar
:page-permalink: apim_overview_components.html
:page-folder: apim/overview
Next sections are describing top components which are part of Gravitee.io.
== Gateway
The gateway is the core component of the Gravitee.io platform. You can compare it to a "smart" proxy to understand its goal.
Unlike traditional HTTP proxy, the gateway is able to apply <<apim_overview_plugins.adoc#gravitee-plugins-policies, policies>> (ie. rules) to
both HTTP requests and responses according to your needs, meaning that you can enhance requests and responses processing
by adding transformation, security, and many other crazy features!
.Gravitee.io - Gateway Internal
image::architecture/graviteeio-gateway-internal.png[Gravitee.io - Gateway Internal]
.Gravitee.io - Gateway Architecture
image::architecture/graviteeio-gateway-architecture.png[Gravitee.io - Gateway Architecture]
== Management API
A restful API providing a bunch of services to manage and configure the global platform. All exposed
services are constraint by authentication and authorization rules.
You can find more information by having a look to the link:/apim_installguide_management_api_documentation.html[Management API > Documentation] section.
== Management UI
This is the Web UI for <<gravitee-components-mgmt-api, Gravitee.io Management API>>. This UI acts as a management tool
for API Publishers but also as a portal for your API Consumers.
``` |
d6f7a9af-ae98-4b88-926b-0a270e49883a | {
"language": "AsciiDoc"
} | ```asciidoc
= Talend component for Neo4j
Benoit Simard <[email protected]>
V1.0
:experimental:
:toc:
:toc-placement: preamble
:toc-title: pass:[<b>Table of Contents</b>]
:outfilesuffix-old: {outfilesuffix}
ifdef::env-github[:outfilesuffix: .adoc]
ifndef::env-github[]
:idprefix:
:idseparator: -
endif::[]
image:https://travis-ci.org/sim51/neo4j-talend-component.svg?branch=master["Build Status", link="https://travis-ci.org/sim51/neo4j-talend-component"]
image:https://coveralls.io/repos/github/sim51/neo4j-talend-component/badge.svg?branch=master["Coverage Status", link="https://coveralls.io/github/sim51/neo4j-talend-component?branch=master"]
Project website : http://sim51.github.io/neo4j-talend-component/
== TODO
* Remake packaging phase for the assembly (there is some cobertura thing into compile class on the archive)
```
Remove done job on todo list | ```asciidoc
= Talend component for Neo4j
Benoit Simard <[email protected]>
V1.0
:experimental:
:toc:
:toc-placement: preamble
:toc-title: pass:[<b>Table of Contents</b>]
:outfilesuffix-old: {outfilesuffix}
ifdef::env-github[:outfilesuffix: .adoc]
ifndef::env-github[]
:idprefix:
:idseparator: -
endif::[]
image:https://travis-ci.org/sim51/neo4j-talend-component.svg?branch=master["Build Status", link="https://travis-ci.org/sim51/neo4j-talend-component"]
image:https://coveralls.io/repos/github/sim51/neo4j-talend-component/badge.svg?branch=master["Coverage Status", link="https://coveralls.io/github/sim51/neo4j-talend-component?branch=master"]
Project website : http://sim51.github.io/neo4j-talend-component/
== TODO
``` |
362a7c7d-e5f2-493f-a0b9-8d21ae078591 | {
"language": "AsciiDoc"
} | ```asciidoc
== asciidoctor-fopub-embed-svg-example
An example for embedding SVG images in an asciidoctor document.
=== Setup
----
bundle install
----
=== How to make the target pdf file
Running the command below make the target pdf file named "class_diagram.pdf" out of "class_diagram.adoc"
----
bundle exec rake
----
=== Watch *.adoc files
Running the command below, rake watches "\*.adoc" files and build "*.adoc" files whenever they are modified.
----
bundle exec rake watch
----
=== Example output files
You can see the example output files at
* https://hnakamur.github.io/asciidoctor-fopub-embed-svg-example/class_diagram.pdf[class_diagram.pdf]
=== Note
You must be add `width` and `height` attributes to the root `<svg>` element.
Without these, you got redundant spaces between the embedded image and the following text.
```
Add deleted html example link | ```asciidoc
== asciidoctor-fopub-embed-svg-example
An example for embedding SVG images in an asciidoctor document.
=== Setup
----
bundle install
----
=== How to make the target pdf file
Running the command below make the target pdf file named "class_diagram.pdf" out of "class_diagram.adoc"
----
bundle exec rake
----
=== Watch *.adoc files
Running the command below, rake watches "\*.adoc" files and build "*.adoc" files whenever they are modified.
----
bundle exec rake watch
----
=== Example output files
You can see the example output files at
* https://hnakamur.github.io/asciidoctor-fopub-embed-svg-example/class_diagram.pdf[class_diagram.pdf]
* https://hnakamur.github.io/asciidoctor-fopub-embed-svg-example/class_diagram.html[class_diagram.html]
=== Note
You must be add `width` and `height` attributes to the root `<svg>` element.
Without these, you got redundant spaces between the embedded image and the following text.
``` |
24dd9e3d-a8c7-460e-8662-8e15df48f29b | {
"language": "AsciiDoc"
} | ```asciidoc
== Source release to pypi
python setup.py release --skip-tests --pypi
== Sign source release for GitHub
gpg --detach-sign dist/yubikey-manager-VERSION.tar.gz
== Releasing on macOS
python setup.py executable
resources/fix_libusb_dep_app_bundle.sh dist/YubiKey\ Manager.app/
codesign -s 'Developer ID Application' dist/YubiKey\ Manager.app/ --deep
sudo pkgbuild --install-location /Applications --component dist/YubiKey\ Manager.app/ dist/installer.pkg
productsign -s 'Developer ID Installer' dist/installer.pkg dist/yubikey-manager-VERSION-mac.pkg
gpg --detach-sign dist/yubikey-manager-VERSION-mac.pkg
== Releasing on Windows
python setup.py executable
gpg --detach-sign dist/yubikey-manager-VERSION-win.exe
```
Update code signing commands for macOS | ```asciidoc
== Source release to pypi
python setup.py release --skip-tests --pypi
== Sign source release for GitHub
gpg --detach-sign dist/yubikey-manager-VERSION.tar.gz
== Releasing on macOS
python setup.py executable
resources/fix_libusb_dep_app_bundle.sh dist/YubiKey\ Manager.app/
codesign --deep --force --verify --verbose --sign 'Developer ID Application' dist/YubiKey\ Manager.app/
sudo pkgbuild --sign 'Developer ID Installer' --install-location /Applications --component dist/YubiKey\ Manager.app/ dist/installer.pkg
gpg --detach-sign dist/yubikey-manager-VERSION-mac.pkg
== Releasing on Windows
python setup.py executable
gpg --detach-sign dist/yubikey-manager-VERSION-win.exe
``` |
9a9797fe-4d69-4047-98bd-24724169a090 | {
"language": "AsciiDoc"
} | ```asciidoc
= Implementation protocols
Franz Wilhelmstötter <[email protected]>
:Author Initials: FWi
:toc:
:icons:
:numbered:
:website: http://jenetics.io/
While implementing the library, a lot of concrete implementation decisions have been made. This document gives a more detailed description of some selected implementation details.
include::CreateRandomSeed.adoc[]
include::OptimizeMinimum.adoc[]
```
Update main document of 'Implementation protocol'. | ```asciidoc
= Implementation protocols
Franz Wilhelmstötter <[email protected]>
:Author Initials: FWi
:toc:
:icons:
:numbered:
:website: http://jenetics.io/
While implementing the library, a lot of concrete implementation decisions have been made. This document gives a more detailed description of selected implementation details.
include::CreateRandomSeed.adoc[]
include::OptimizeMinimum.adoc[]
``` |
4ddecad0-16b2-40e4-9302-e020d491a252 | {
"language": "AsciiDoc"
} | ```asciidoc
[[elasticsearch-reference]]
= Elasticsearch Reference
:version: 2.2.0
:branch: 2.0
:major-version: 2.x
:jdk: 1.8.0_25
:defguide: https://www.elastic.co/guide/en/elasticsearch/guide/current
:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/2.x
:issue: https://github.com/elastic/elasticsearch/issues
:pull: https://github.com/elastic/elasticsearch/pull
include::getting-started.asciidoc[]
include::setup.asciidoc[]
include::migration/index.asciidoc[]
include::api-conventions.asciidoc[]
include::docs.asciidoc[]
include::search.asciidoc[]
include::aggregations.asciidoc[]
include::indices.asciidoc[]
include::cat.asciidoc[]
include::cluster.asciidoc[]
include::query-dsl.asciidoc[]
include::mapping.asciidoc[]
include::analysis.asciidoc[]
include::modules.asciidoc[]
include::index-modules.asciidoc[]
include::testing.asciidoc[]
include::glossary.asciidoc[]
include::release-notes.asciidoc[]
include::redirects.asciidoc[]
```
Fix :issue: and :pull: asciidoc replacements | ```asciidoc
[[elasticsearch-reference]]
= Elasticsearch Reference
:version: 2.2.0
:branch: 2.x
:major-version: 2.x
:jdk: 1.8.0_25
:defguide: https://www.elastic.co/guide/en/elasticsearch/guide/current
:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/2.x
:issue: https://github.com/elastic/elasticsearch/issues/
:pull: https://github.com/elastic/elasticsearch/pull/
include::getting-started.asciidoc[]
include::setup.asciidoc[]
include::migration/index.asciidoc[]
include::api-conventions.asciidoc[]
include::docs.asciidoc[]
include::search.asciidoc[]
include::aggregations.asciidoc[]
include::indices.asciidoc[]
include::cat.asciidoc[]
include::cluster.asciidoc[]
include::query-dsl.asciidoc[]
include::mapping.asciidoc[]
include::analysis.asciidoc[]
include::modules.asciidoc[]
include::index-modules.asciidoc[]
include::testing.asciidoc[]
include::glossary.asciidoc[]
include::release-notes.asciidoc[]
include::redirects.asciidoc[]
``` |
ccdf5e2a-c8e5-4f91-b223-ad11070a48c8 | {
"language": "AsciiDoc"
} | ```asciidoc
= Edge App
Until CIDER 0.17 has been released (which brings improved support for
Clojure CLI), please use a terminal to run `clj`.
Ensure that you are in the `app` sub-directory.
----
$ ./bin/dev
dev=> (go)
----
This starts an nrepl-server, the port is announced on the command line.
== Cursive support
Current versions of Cursive don't support `deps.edn`, but will work with a `pom.xml`.
You can generate the `pom.xml` with the following command:
----
$ clojure -Spom
----
```
Update docs to reflect dev->repl | ```asciidoc
= Edge App
Until CIDER 0.17 has been released (which brings improved support for
Clojure CLI), please use a terminal to run `clj`.
Ensure that you are in the `app` sub-directory.
----
$ ./bin/repl
dev=> (go)
----
This starts an nrepl-server, the port is announced on the command line.
== Cursive support
Current versions of Cursive don't support `deps.edn`, but will work with a `pom.xml`.
You can generate the `pom.xml` with the following command:
----
$ clojure -Spom
----
``` |
329dadba-1a8f-4851-a948-ed03df844c11 | {
"language": "AsciiDoc"
} | ```asciidoc
# Conventions over configuration
This document covers conventions used in Dogen that may help you build Dockerfiles faster and easier.
## Handling YUM/DNF repo files
In case you add YUM/DNF repo files that you want to put to the `/etc/yum.repos.d` directory
to enable additional repositories Dogen will handle it for you automatically.
If Dogen will detect files
with `.repo` extension in the `scripts` directory located under the target (output) directory Dogen will
automatically copy all these files to `/etc/yum.repos.d` directory and enable them to be used while
installing packages listed in the `packages` section.
After installation Dogen removes newly added repo files from the `/etc/yum.repos.d` directory *automatically*.
If you do not want to have these files removed after installation -- you need to make your repo files
part of some package and install them manually.
### Things to note
1. This feature covers only the situation where you want to add a custom repo file at *build
time* but you do not want it to be enabled in containers.
2. Repo file name should be the *same* as the repo id in the repository
(the name between square brackets).
3. There should be *only one* repository per file.
4. Only added repositories will be enabled during install of packages, all other repositories (including default)
will be *disabled*.
## Running scripts
### Default script name
If you do not specify an `exec` key for a script, dogen will check for a script named `run`
and execute it if it exists.
```
Document default user is root | ```asciidoc
# Conventions over configuration
This document covers conventions used in Dogen that may help you build Dockerfiles faster and easier.
## Handling YUM/DNF repo files
In case you add YUM/DNF repo files that you want to put to the `/etc/yum.repos.d` directory
to enable additional repositories Dogen will handle it for you automatically.
If Dogen will detect files
with `.repo` extension in the `scripts` directory located under the target (output) directory Dogen will
automatically copy all these files to `/etc/yum.repos.d` directory and enable them to be used while
installing packages listed in the `packages` section.
After installation Dogen removes newly added repo files from the `/etc/yum.repos.d` directory *automatically*.
If you do not want to have these files removed after installation -- you need to make your repo files
part of some package and install them manually.
### Things to note
1. This feature covers only the situation where you want to add a custom repo file at *build
time* but you do not want it to be enabled in containers.
2. Repo file name should be the *same* as the repo id in the repository
(the name between square brackets).
3. There should be *only one* repository per file.
4. Only added repositories will be enabled during install of packages, all other repositories (including default)
will be *disabled*.
## Running scripts
### Default script name
If you do not specify an `exec` key for a script, dogen will check for a script named `run`
and execute it if it exists.
### Default script execution user
Dogen will execute all scripts as `root` unless you have specified a user with the `user` key.
``` |
c76f48fe-be0e-434b-9b66-77f1f1b4865c | {
"language": "AsciiDoc"
} | ```asciidoc
include::{stream-docs-basedir}/core/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc[]
= Binder Implementations
== Apache Kafka Binder
include::{stream-docs-basedir}/kafka/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/overview.adoc[leveloffset=+1]
== RabbitMQ Binder
include::{stream-docs-basedir}/rabbit/spring-cloud-stream-binder-rabbit-docs/src/main/asciidoc/overview.adoc[leveloffset=+1]
```
Fix the addition of Rabbit DLQ documentation | ```asciidoc
include::{stream-docs-basedir}/core/spring-cloud-stream-core-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc[]
= Binder Implementations
== Apache Kafka Binder
include::{stream-docs-basedir}/kafka/spring-cloud-stream-binder-kafka-docs/src/main/asciidoc/overview.adoc[leveloffset=+1]
== RabbitMQ Binder
include::{stream-docs-basedir}/rabbit/spring-cloud-stream-binder-rabbit-docs/src/main/asciidoc/overview.adoc[leveloffset=+1]
include::{stream-docs-basedir}/rabbit/spring-cloud-stream-binder-rabbit-docs/src/main/asciidoc/dlq.adoc[leveloffset=+1]
``` |
57f18f8e-bfde-48bf-85c9-9f8f066ecee3 | {
"language": "AsciiDoc"
} | ```asciidoc
// Module included in the following assemblies:
//
// * configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-ingress-controller.adoc
// * ingress-operator.adoc
[id="nw-ingress-sharding-namespace-labels_{context}"]
= Configuring ingress controller sharding by using namespace labels
Ingress Controller sharding by using namespace labels means that the Ingress
Controller serves any route in any namespace that is selected by the namespace
selector.
Ingress Controller sharding is useful when balancing incoming traffic load among
a set of Ingress Controllers and when isolating traffic to a specific Ingress
Controller. For example, company A goes to one Ingress Controller and company B
to another.
.Procedure
. Edit the `router-internal.yaml` file:
+
----
# cat router-internal.yaml
apiVersion: v1
items:
- apiVersion: operator.openshift.io/v1
kind: IngressController
metadata:
name: sharded
namespace: openshift-ingress-operator
spec:
domain: <apps-sharded.basedomain.example.net>
nodePlacement:
nodeSelector:
matchLabels:
node-role.kubernetes.io/worker: ""
routeSelector:
matchLabels:
type: sharded
status: {}
kind: List
metadata:
resourceVersion: ""
selfLink: ""
----
. Apply the Ingress Controller `router-internal.yaml` file:
+
----
# oc apply -f router-internal.yaml
----
+
The Ingress Controller selects routes in any namespace that is selected by the
namespace selector that have the label `type: sharded`.
```
Fix example for ingress sharding by namespace | ```asciidoc
// Module included in the following assemblies:
//
// * configuring_ingress_cluster_traffic/configuring-ingress-cluster-traffic-ingress-controller.adoc
// * ingress-operator.adoc
[id="nw-ingress-sharding-namespace-labels_{context}"]
= Configuring ingress controller sharding by using namespace labels
Ingress Controller sharding by using namespace labels means that the Ingress
Controller serves any route in any namespace that is selected by the namespace
selector.
Ingress Controller sharding is useful when balancing incoming traffic load among
a set of Ingress Controllers and when isolating traffic to a specific Ingress
Controller. For example, company A goes to one Ingress Controller and company B
to another.
.Procedure
. Edit the `router-internal.yaml` file:
+
----
# cat router-internal.yaml
apiVersion: v1
items:
- apiVersion: operator.openshift.io/v1
kind: IngressController
metadata:
name: sharded
namespace: openshift-ingress-operator
spec:
domain: <apps-sharded.basedomain.example.net>
nodePlacement:
nodeSelector:
matchLabels:
node-role.kubernetes.io/worker: ""
namespaceSelector:
matchLabels:
type: sharded
status: {}
kind: List
metadata:
resourceVersion: ""
selfLink: ""
----
. Apply the Ingress Controller `router-internal.yaml` file:
+
----
# oc apply -f router-internal.yaml
----
+
The Ingress Controller selects routes in any namespace that is selected by the
namespace selector that have the label `type: sharded`.
``` |
1792a234-9fe3-4a56-bf96-d3f611e28545 | {
"language": "AsciiDoc"
} | ```asciidoc
== License
+++<a href="http://deepsymmetry.org"><img src="_images/DS-logo-bw-200-padded-left.png" align="right" alt="Deep Symmetry logo" width="216" height="123"></a>+++
Copyright © 2015–2019 http://deepsymmetry.org[Deep Symmetry, LLC]
Distributed under the https://opensource.org/licenses/EPL-2.0[Eclipse
Public License 2.0]. By using this software in any fashion, you are
agreeing to be bound by the terms of this license. You must not remove
this notice, or any other, from this software. A copy of the license
can be found in
https://github.com/Deep-Symmetry/afterglow/blob/master/LICENSE[LICENSE]
within this project.
```
Update user guide copyright date. | ```asciidoc
== License
+++<a href="http://deepsymmetry.org"><img src="_images/DS-logo-bw-200-padded-left.png" align="right" alt="Deep Symmetry logo" width="216" height="123"></a>+++
Copyright © 2015–2020 http://deepsymmetry.org[Deep Symmetry, LLC]
Distributed under the https://opensource.org/licenses/EPL-2.0[Eclipse
Public License 2.0]. By using this software in any fashion, you are
agreeing to be bound by the terms of this license. You must not remove
this notice, or any other, from this software. A copy of the license
can be found in
https://github.com/Deep-Symmetry/afterglow/blob/master/LICENSE[LICENSE]
within this project.
``` |
6d80cee4-0e81-4df2-a6b8-9c675a3ca927 | {
"language": "AsciiDoc"
} | ```asciidoc
WARNING: Be sure to add the dependency to the `dependencies` section of the `build.gradle` file, and not the `buildscript`/`dependencies` section. The former is for application dependencies (needed for at compile time, runtime, or testing), whereas the `buildscript` `dependencies` is for those needed as part of the Gradle build process (managing static assets, for example).
```
Correct typo in common warning | ```asciidoc
WARNING: Be sure to add the dependency to the `dependencies` section of the `build.gradle` file, and not the `buildscript`/`dependencies` section. The former is for application dependencies (needed at compile time, runtime, or for testing), whereas the `buildscript` `dependencies` is for those needed as part of the Gradle build process (managing static assets, for example).
``` |
46a794cb-23c0-40f1-9eff-4a40366bed3d | {
"language": "AsciiDoc"
} | ```asciidoc
== New Releases Restoring Compatibility
Revapi has started to use Java 9 for building while maintaining compatibility with Java 8 using the Animal Sniffer Maven
plugin. This has proven to be problematic and the link:20171015-releases.html[last] releases could not be used with
Java 8. This should be now fixed and compatibility with Java 8 restored.
The following were released:
* Revapi API 0.8.4
* Revapi Basic Features 0.6.3
* Revapi Ant Task 0.6.3
* Revapi Java SPI 0.14.0
* Revapi Java Extension 0.14.3
* Revapi Text Reporter 0.8.2
* Revapi Standalone 0.6.4
* Revapi Maven Plugin 0.9.4
In addition to the above fix, a new artifact is now released `revapi-java-test-support` starting at version `0.1.0`.
This artifact is supposed to help custom extensions with testing by providing simple utilities to build, compile and
inspect custom jar files.
```
Add a thank-you message to the release notes. | ```asciidoc
== New Releases Restoring Compatibility
Revapi has started to use Java 9 for building while maintaining compatibility with Java 8 using the Animal Sniffer Maven
plugin. This has proven to be problematic and the link:20171015-releases.html[last] releases could not be used with
Java 8. This should be now fixed and compatibility with Java 8 restored.
The following were released:
* Revapi API 0.8.4
* Revapi Basic Features 0.6.3
* Revapi Ant Task 0.6.3
* Revapi Java SPI 0.14.0
* Revapi Java Extension 0.14.3
* Revapi Text Reporter 0.8.2
* Revapi Standalone 0.6.4
* Revapi Maven Plugin 0.9.4
In addition to the above fix, a new artifact is now released `revapi-java-test-support` starting at version `0.1.0`.
This artifact is supposed to help custom extensions with testing by providing simple utilities to build, compile and
inspect custom jar files.
Thanks go out to Petr Široký who found, diagnosed and fixed the compatibility issue. Petr, you're a star!
``` |
f03a878d-eef1-4a41-9164-35929237ea66 | {
"language": "AsciiDoc"
} | ```asciidoc
= AsciiDoc Book Starter
This is the starter folder structure for writing book with AsciiDoc.
Inspired by https://github.com/progit/progit2[Pro Git 2].
== Building
run `rake` to build book.
run `rake book:build_chapter_html` to build each chapter into HTML file.
== Lincense
The MIT License
```
Update readme to include installation. Add bundler: exec needs a command to run to the Converting to HTML... -- HTML output at output/master.html Converting to EPub... -- Epub output at output/master.epub Converting to Mobi (kf8)... -- Mobi output at output/master.mobi Converting to PDF... (this one takes a while) -- PDF output at output/master.pdf command. | ```asciidoc
= AsciiDoc Book Starter
This is the starter folder structure for writing book with AsciiDoc.
Inspired by https://github.com/progit/progit2[Pro Git 2].
== Installation
Install the gems via `bundle install`.
== Building
run `bundle exec rake` to build book.
run `bundle exec rake book:build_chapter_html` to build each chapter into HTML file.
== Lincense
The MIT License
``` |
aeff9cf3-2a9a-4e72-ba0b-9180a7d220ba | {
"language": "AsciiDoc"
} | ```asciidoc
:moduledir: ..
:attachmentsdir: {moduledir}/assets/attachments
:examplesdir: {moduledir}/examples
:imagesdir: {moduledir}/assets/images
:partialsdir: {moduledir}/pages/_partials
:debezium-version: 0.10.0.Beta4
:debezium-dev-version: 0.10
:debezium-kafka-version: 2.3.0
:debezium-docker-label: 0.10
:install-version: 0.10
:confluent-platform-version: 5.1.2
:strimzi-version: 0.9.0
```
Update documentation version attributes | ```asciidoc
:moduledir: ..
:attachmentsdir: {moduledir}/assets/attachments
:examplesdir: {moduledir}/examples
:imagesdir: {moduledir}/assets/images
:partialsdir: {moduledir}/pages/_partials
:debezium-version: 1.0.0.Beta2
:debezium-dev-version: 1.0
:debezium-kafka-version: 2.3.0
:debezium-docker-label: 1.0
:install-version: 1.0
:confluent-platform-version: 5.1.2
:strimzi-version: 0.9.0
``` |
dd3d3c8e-ef0e-4248-a6a4-fb4663676e6d | {
"language": "AsciiDoc"
} | ```asciidoc
= Neo4j-OGM - An Object Graph Mapping Library for Neo4j
ifdef::backend-html5[(C) {copyright}]
ifndef::backend-pdf[]
License: link:{common-license-page-uri}[Creative Commons 4.0]
endif::[]
ifdef::backend-pdf[]
(C) {copyright}
License: <<license, Creative Commons 4.0>>
endif::[]
[abstract]
--
This is the Neo4j object-graph mapping (OGM) manual, authored by the Neo4j team.
--
The three parts of the manual are:
* <<introduction>> -- Introducing graph database concepts, Neo4j and object-graph mapping.
* <<tutorial>> -- Follow along as you get started using Neo4j-OGM.
* <<reference>> -- Reference documentation for Neo4j-OGM.
But before starting, let's see the most important new features.
include::introduction/index.adoc[leveloffset=+1]
include::tutorial/index.adoc[leveloffset=+1]
include::reference/index.adoc[leveloffset=+1]
:numbered!:
include::appendix/migration-2.1-to-3.0.adoc[leveloffset=+1]
include::appendix/design-considerations.adoc[leveloffset=+1]
include::appendix/faq.adoc[leveloffset=+1]
ifdef::backend-pdf[]
include::{license-dir}/license.adoc[leveloffset=1]
endif::[]
```
Add Neo4j-OGM version in short description. | ```asciidoc
= Neo4j-OGM - An Object Graph Mapping Library for Neo4j
ifdef::backend-html5[(C) {copyright}]
ifndef::backend-pdf[]
License: link:{common-license-page-uri}[Creative Commons 4.0]
endif::[]
ifdef::backend-pdf[]
(C) {copyright}
License: <<license, Creative Commons 4.0>>
endif::[]
[abstract]
--
This is the manual of Neo4j object-graph mapping (OGM) v{ogm-doc-version}, authored by the Neo4j team.
--
The three parts of the manual are:
* <<introduction>> -- Introducing graph database concepts, Neo4j and object-graph mapping.
* <<tutorial>> -- Follow along as you get started using Neo4j-OGM.
* <<reference>> -- Reference documentation for Neo4j-OGM.
But before starting, let's see the most important new features.
include::introduction/index.adoc[leveloffset=+1]
include::tutorial/index.adoc[leveloffset=+1]
include::reference/index.adoc[leveloffset=+1]
:numbered!:
include::appendix/migration-2.1-to-3.0.adoc[leveloffset=+1]
include::appendix/design-considerations.adoc[leveloffset=+1]
include::appendix/faq.adoc[leveloffset=+1]
ifdef::backend-pdf[]
include::{license-dir}/license.adoc[leveloffset=1]
endif::[]
``` |
1edd8747-dbc4-42cb-b5f1-1da8723fdc9d | {
"language": "AsciiDoc"
} | ```asciidoc
= TodoService - World's least awesome Web View and REST Service for TODO
This will be a nice working TODO app by 2022..
For now it provides a trivial ToDo lister/editor for one person via HTML (JSF).
Uses ../TodoModel for its JPA Data; do mvn install in that project first.
It will someday soon also provide a REST interface, which will be awesome enough
that there will also be an Android Synch Service to go with it.
You need to copy config-sample.properties to config.properties, and edit it.
Assuming you're using Wildfly 8 or 9 and PostGres 9,, just set up the datasource and do `mvn wildfly:deploy`
Things do do.
Better UI!
Move away from container-managed security so it can more easily become multi-user.
```
Split into JSF and REST | ```asciidoc
= TodoService - World's least awesome REST Service for TODO
This will be a nice working TODO app by 2022..
For now it provides a trivial ToDo lister/editor for one person via HTML (JSF).
Uses ../TodoModel for its JPA Data; do mvn install in that project first.
You need to copy config-sample.properties to config.properties, and edit it.
Assuming you're using Wildfly 8 or 9 and PostGreSQL 9, just set up the datasource and do `mvn wildfly:deploy`
== Things do do.
Move away from container-managed security so it can more easily become multi-user.
== BUGS
The only reason this is split off from TodoJSF is that Java EE doesn't allow two
login-config elements, we need FORM for the JSF and BASIC for the REST. Sigh...
``` |
be431ba9-d9ea-4be5-90fd-dab49f83761a | {
"language": "AsciiDoc"
} | ```asciidoc
= Docker test training
== Prerequisites
* Hebben ze docker geinstalleerd? Zo nee, doen!
== Doel van de presentatie
* Basisconcepten van Docker uitleggen
* Simpele voorbeelden van containers
* Workshop met als doel zelf webpagina met DB backend testen mbv Docker
=== Vragen wat mensen nog meer zouden willen weten
== Wat is docker?
* Docker vs VM: de verschillen (-> networking)
* Docker distributie model (git-achtig)
* Docker client/server
* Container file systeem -> volumes
== Simpele voorbeelden:
* docker run hello-world
* docker run bash -> docker inspect, docker ps
* docker run nginx -> in browser laten zien
* docker run pgsql -> inloggen met pgadmin
== Labs
* start nginx container met statische inhoud
** volume mounten, aanpassen etc
* nginx + selenium, klein testje (java omgeving?)
* nginx + selenium + database, test dynamische pagina (docker link)
== Extra credit lab
* Met docker build pgsql image aanpassen dat ie automatisch baseline data inlaadt, die weer gebruiken in de test
```
Update the readme for github | ```asciidoc
= Docker for testers
This repository contains training material for testers that want to get started with http://www.docker.com[Docker]. It was developed by engineers at http://www.bol.com[bol.com].
== Building the course material
NOTE: You must have a recent version of the http://www.oracle.com/technetwork/java/javase/downloads/index.html[JDK] installed to build the course material.
The course material is written in http://asciidoctor.org/[Asciidoctor] and can be built using the following command:
./gradlew assemble
This command will generate a zip file containing all the material in the `workshop/build/distributions` directory.``` |
dcbd7bf0-f239-4be7-bf97-4a56124483ee | {
"language": "AsciiDoc"
} | ```asciidoc
= SpringBoot WebApp Demo
https://projects.spring.io/spring-boot[Spring Boot]
looks like a nice way to get started.
This is a trivial webapp created using SpringBoot.
== HowTo
mvn spring-boot:run
Or, in Eclipse with Spring plugin (or "Spring Tool Suite"),
right-click project or Application.java,
then RunAs->Spring Boot Application
Seconds later, connect to
http://localhost:8000/
Note: that is port 8000, _not_ the usual 8080, to avoid conflicts.
Change this in application.properties if you don't like it.
Fill in the form and click Submit.
== War Packaging for EE App Server Deployment
This version has the modifications described in
the section entitled "Traditional Deployment"--"Create a deployable war file" in
the spring-boot reference manual (Section 85.1 as of
this writing).
it still works in Maven and Eclipse with these settings,
and the packaged was file has a jboss-web.xml config file
so it deploys as /springbootdemos when you simply copy the war file to
WILDFLYHOME/standalone/deployments.
```
Fix typo; while here, tweak wording, formatting. | ```asciidoc
= SpringBoot WebApp Demo
https://projects.spring.io/spring-boot[Spring Boot]
looks like a nice way to get started.
This is a trivial webapp created using SpringBoot.
== HowTo
mvn spring-boot:run
Or, in Eclipse with Spring plugin (or "Spring Tool Suite"),
right-click project or Application.java,
then RunAs->Spring Boot Application
Seconds later, connect to
http://localhost:8000/
Note: that is port 8000, _not_ the usual 8080, to avoid conflicts.
Change this in application.properties if you don't like it.
Fill in the form and click Submit.
== War Packaging for EE App Server Deployment
This version has the modifications described in
the section entitled "Traditional Deployment"--"Create a deployable war file" in
the spring-boot reference manual (Section 85.1 as of
this writing).
it still works in Maven (`mvn package`) and can be run in Eclipse with these settings.
For WildFly users, the packaged _war_ file has a jboss-web.xml config file
so it deploys as _/springbootdemos_ when you simply copy the _war_ file to
WILDFLYHOME/standalone/deployments.
``` |
339cd127-25ec-42ec-9443-e84f133efab8 | {
"language": "AsciiDoc"
} | ```asciidoc
= Blueprint
:author: Hafid Haddouti
image:https://travis-ci.org/haf-tech/blueprint.svg?branch=master["Build Status", link="https://travis-ci.org/haf-tech/blueprint"]
image:https://img.shields.io/badge/License-Apache%202.0-blue.svg["License", link="https://opensource.org/licenses/Apache-2.0"]
Blueprint is a playground for illustrating different paradigms.
In the meantime the following concepts are integrated or planned:
- Spring Boot
- AsciiDoctor integration, with UML and different outputs
- Onion architecture
- Docker build/push
Next:
- reactive programming
An up to date documentation is https://haf-tech.github.io/blueprint/[online] available.
```
Add badge for SonarQube integration | ```asciidoc
= Blueprint
:author: Hafid Haddouti
image:https://travis-ci.org/haf-tech/blueprint.svg?branch=master["Build Status", link="https://travis-ci.org/haf-tech/blueprint"]
image:https://img.shields.io/badge/License-Apache%202.0-blue.svg["License", link="https://opensource.org/licenses/Apache-2.0"]
image:https://sonarqube.com/api/badges/gate?key=com.haddouti.pg%3Ablueprint-parent["Sonar Quality Gate", link="https://sonarqube.com/api/badges/gate?key=com.haddouti.pg%3Ablueprint-parent"]
Blueprint is a playground for illustrating different paradigms.
In the meantime the following concepts are integrated or planned:
- Spring Boot
- AsciiDoctor integration, with UML and different outputs
- Onion architecture
- Docker build/push
Next:
- reactive programming
An up to date documentation is https://haf-tech.github.io/blueprint/[online] available.
``` |
173ce9ce-ec78-4fe8-91bd-5ed2f6e861f0 | {
"language": "AsciiDoc"
} | ```asciidoc
= Tiny Request Limits Library designed for Java 8
:hardbreaks:
image:https://travis-ci.org/storozhukBM/requestlimit.svg?branch=master["Build Status", link="https://travis-ci.org/storozhukBM/requestlimit"] image:https://coveralls.io/repos/github/storozhukBM/requestlimit/badge.svg["Coverage Status", link="https://coveralls.io/github/storozhukBM/requestlimit"]```
Rebuild master with coverage report | ```asciidoc
= Tiny Request Limits Library designed for Java 8
:hardbreaks:
image:https://travis-ci.org/storozhukBM/requestlimit.svg?branch=master["Build Status", link="https://travis-ci.org/storozhukBM/requestlimit"] image:https://coveralls.io/repos/github/storozhukBM/requestlimit/badge.svg["Coverage Status", link="https://coveralls.io/github/storozhukBM/requestlimit"]``` |
939a2732-7176-49b5-9234-1dab696077dd | {
"language": "AsciiDoc"
} | ```asciidoc
= OmniJ Release Process
== Main Release Process
. Official builds are now done with JDK 11. (Although most release JARs are JDK 8-compatible)
.. `sdk use java 11.0.10.hs-adpt`
. Update `CHANGELOG.adoc`
. Set versions
.. `gradle.properties`
.. omnij-dsl `ExtensionModule`
.. `README.adoc`
. Commit version bump and changelog.
. Full build, test
.. `./gradlew clean buildCI regTest`
. Tag: `git tag -a v0.x.y -m "Release 0.x.y"`
. Push: `git push --tags origin master`
. Publish to Bintray:
.. `./gradlew bintrayUpload`
.. Confirm publish of artifacts in Bintray Web UI.
. Publish Github pages site including JavaDoc and GroovyDoc
.. `./gradlew publishSite`
. Publish to Github Packages
.. `./gradlew publish`
. Update Github https://github.com/OmniLayer/OmniJ/releases[OmniJ Releases] page.
== Announcements
. Not yet.
== After release
. Set versions back to -SNAPSHOT
.. `gradle.properties`
.. omnij-dsl `ExtensionModule`
.. `CHANGELOG.adoc`
.. *Not* `README.adoc` -- it should match release version
. Commit and push to master
== Publish Snapshot release to Github Maven repo
. `.gradlew clean buildCI regTest publish`
== Install Snapshot to local maven repo
. `./gradlew clean buildCI publishToMavenLocal`
```
Update release process for Gitlab Maven repo | ```asciidoc
= OmniJ Release Process
== Main Release Process
. Official builds are now done with JDK 11. (Although most release JARs are JDK 8-compatible)
.. `sdk use java 11.0.10.hs-adpt`
. Update `CHANGELOG.adoc`
. Set versions
.. `gradle.properties`
.. omnij-dsl `ExtensionModule`
.. `README.adoc`
. Commit version bump and changelog.
. Full build, test
.. `./gradlew clean buildCI regTest`
. Tag: `git tag -a v0.x.y -m "Release 0.x.y"`
. Push: `git push --tags origin master`
. Publish to Gitlab Maven repo:
.. `./gradlew publish`
. Publish Github pages site including JavaDoc and GroovyDoc
.. `./gradlew publishSite`
. Update Github https://github.com/OmniLayer/OmniJ/releases[OmniJ Releases] page.
== Announcements
. Not yet.
== After release
. Set versions back to -SNAPSHOT
.. `gradle.properties`
.. omnij-dsl `ExtensionModule`
.. `CHANGELOG.adoc`
.. *Not* `README.adoc` -- it should match release version
. Commit and push to master
== Publish Snapshot release to Github Maven repo
. `.gradlew clean buildCI regTest publish`
== Install Snapshot to local maven repo
. `./gradlew clean buildCI publishToMavenLocal`
``` |
f0e37b55-545c-4ada-87c6-a8901b967868 | {
"language": "AsciiDoc"
} | ```asciidoc
= Installation
RuboCop's installation is pretty standard:
[source,sh]
----
$ gem install rubocop
----
If you'd rather install RuboCop using `bundler`, don't require it in your `Gemfile`:
[source,rb]
----
gem 'rubocop', require: false
----
RuboCop's development is moving at a very rapid pace and there are
often backward-incompatible changes between minor releases (since we
haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
might want to use a conservative version locking in your `Gemfile`:
[source,rb]
----
gem 'rubocop', '~> 0.85.1', require: false
----
NOTE: You can check out our progress on the road to version 1.0 https://github.com/rubocop-hq/rubocop/milestone/4[here].
You can also help us get there faster! :-)
```
Add a sidebar about gems that were extracted from RuboCop | ```asciidoc
= Installation
RuboCop's installation is pretty standard:
[source,sh]
----
$ gem install rubocop
----
If you'd rather install RuboCop using `bundler`, don't require it in your `Gemfile`:
[source,rb]
----
gem 'rubocop', require: false
----
RuboCop's development is moving at a very rapid pace and there are
often backward-incompatible changes between minor releases (since we
haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
might want to use a conservative version locking in your `Gemfile`:
[source,rb]
----
gem 'rubocop', '~> 0.85.1', require: false
----
NOTE: You can check out our progress on the road to version 1.0 https://github.com/rubocop-hq/rubocop/milestone/4[here].
You can also help us get there faster! :-)
.A Modular RuboCop
****
Originally RuboCop bundled cops focused on performance and Ruby on Rails, but those were
extracted into their own gems eventually:
* the performance cops were extracted in `rubocop-performance` and were removed from the main gem in 0.68
* the Ruby on Rails cops were extracted in `rubocop-rails` and were removed from the main gem in 0.72
You'll need to install those gems separately if you'd like to use them.
See https://metaredux.com/posts/2019/05/22/a-modular-rubocop.html[this article] for more details.
Additionally, RuboCop's AST logic was extracted to `rubocop-ast` in RuboCop 0.84. While this change is
transparent to RuboCop's users (`rubocop-ast` is a runtime dependency of `rubocop`), it's good to be
aware that you can leverage RuboCop's AST node extensions and AST node pattern matching outside of RuboCop.
****
``` |
85ead452-a5db-4c5e-b952-cdb0aae92fee | {
"language": "AsciiDoc"
} | ```asciidoc
= _Precompiled_ Math!
:math:
:imagesoutdir: generated_images
:imagesdir: images
## Equations!
[latexmath]
++++
k_{n+1} = n^2 + k_n^2 - k_{n-1}
++++
Some useful text! Formula for quadratic root:
[latexmath]
++++
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
++++
Inline equation works too! latexmath:[a^2+b^2=c^2]. Pretty nice, huh?
```
Add tests for stem macros | ```asciidoc
= _Precompiled_ Math!
:math:
:imagesoutdir: generated_images
:imagesdir: images
:stem: latexmath
## Equations!
[latexmath]
++++
k_{n+1} = n^2 + k_n^2 - k_{n-1}
++++
Some useful text! Formula for quadratic root:
[stem]
++++
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
++++
Inline equation works too! latexmath:[a^2+b^2=c^2]. Or as stem
stem:[a^2+b^2=c^2]. Pretty nice, huh?
``` |
Subsets and Splits