[1/2] lucene-solr:jira/solr-10290: Remove errant .DS_Store file

[ct...@apache.org]

Repository: lucene-solr
Updated Branches:
  refs/heads/jira/solr-10290 46251028f -> 853c4ae04


Remove errant .DS_Store file


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/0e6f187d
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/0e6f187d
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/0e6f187d

Branch: refs/heads/jira/solr-10290
Commit: 0e6f187daed4e571c6fa7f438a5ce7e9fd53ea54
Parents: 4625102
Author: Cassandra Targett <ct...@apache.org>
Authored: Mon Mar 20 10:20:31 2017 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Mon Mar 20 10:20:31 2017 -0500

----------------------------------------------------------------------
 solr/solr-ref-guide/src/fonts/.DS_Store | Bin 6148 -> 0 bytes
 1 file changed, 0 insertions(+), 0 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/0e6f187d/solr/solr-ref-guide/src/fonts/.DS_Store
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/fonts/.DS_Store b/solr/solr-ref-guide/src/fonts/.DS_Store
deleted file mode 100644
index a7796fb..0000000
Binary files a/solr/solr-ref-guide/src/fonts/.DS_Store and /dev/null differ

[2/2] lucene-solr:jira/solr-10290: SOLR-10300, SOLR-10301: add meta-docs directory and first pass at Asciidoc syntax & tools

[ct...@apache.org]

SOLR-10300, SOLR-10301: add meta-docs directory and first pass at Asciidoc syntax & tools


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/853c4ae0
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/853c4ae0
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/853c4ae0

Branch: refs/heads/jira/solr-10290
Commit: 853c4ae0467607d508d8b3a13b60ad4414ef7234
Parents: 0e6f187
Author: Cassandra Targett <ct...@apache.org>
Authored: Mon Mar 20 16:17:45 2017 -0500
Committer: Cassandra Targett <ct...@apache.org>
Committed: Mon Mar 20 16:17:45 2017 -0500

----------------------------------------------------------------------
 .../meta-docs/asciidoc-syntax.adoc              | 223 +++++++++++++++++++
 .../solr-ref-guide/meta-docs/editing-tools.adoc |  23 ++
 2 files changed, 246 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/853c4ae0/solr/solr-ref-guide/meta-docs/asciidoc-syntax.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/meta-docs/asciidoc-syntax.adoc b/solr/solr-ref-guide/meta-docs/asciidoc-syntax.adoc
new file mode 100644
index 0000000..b6e7136
--- /dev/null
+++ b/solr/solr-ref-guide/meta-docs/asciidoc-syntax.adoc
@@ -0,0 +1,223 @@
+= Asciidoc syntax
+:toc:
+
+The definitive manual on Asciidoc syntax is in the http://asciidoctor.org/docs/user-manual/[Asciidoctor User Manual]. To help people get started, however, here is a simpler cheat sheet.
+
+== Basic syntax
+
+=== Bold
+
+Put asterisks around text to make it *bold*.
+
+More info: http://asciidoctor.org/docs/user-manual/#bold-and-italic
+
+=== Italics
+
+Use underlines to put text into _italics_.
+
+More info: http://asciidoctor.org/docs/user-manual/#bold-and-italic
+
+=== Headings
+
+Equal signs (`=`) are used for heading levels. Each equal sign is a level. Each page can *only* have one top level. Levels should be appropriately nested.
+
+Validation occurs to ensure that level 3s are preceded by level 2s, level 4s are preceded by level 3s, etc. Including out-of-sequence heading levels (such as a level 3 then a level 5) will not fail the build, but will produce an error.
+
+More info: http://asciidoctor.org/docs/user-manual/#sections
+
+=== Code Examples
+
+Use backticks ``` for text that should be monospaced, such as a code or class name in the body of a paragraph.
+
+More info: http://asciidoctor.org/docs/user-manual/#mono
+
+Longer code examples can be separated from text with `source` blocks. These allow defining the syntax being used so the code is properly highlighted.
+
+[source]
+.Example Source Block
+----
+[source,xml]
+    <field name="id" type="string" indexed="true" stored="true" required="true" multiValued="false" />
+----
+
+If your code block will include line breaks, put 4 hyphens (`----`) before and after the entire block.
+
+More info: http://asciidoctor.org/docs/user-manual/#source-code-blocks
+
+=== Block Titles
+
+Titles can be added to most blocks (images, source blocks, tables, etc.) by simply prefacing the title with a period (`.`). For example, to add a title to the source block example above:
+
+[source]
+----
+[source,xml]
+.Example ID field
+    <field name="id" type="string" indexed="true" stored="true" required="true" multiValued="false" />
+----
+
+== Links
+
+=== Link to Sites on the Internet
+When converting content to HTML or PDF, Asciidoctor will automatically render many link types (such as `http:` and `mailto:`) without any additional syntax.
+
+However, you can add a name to a link by adding the URI followed by square brackets:
+
+[source]
+http://lucene.apache.org/solr[Solr Website]
+
+=== Link to Other Pages/Sections of the Guide
+A warning up front, linking to other pages can be a little bit painful.
+
+To link to an anchor (or heading) on the _same page_, you can simply use double angle brackets (`<< >>`) around the anchor/heading/section name. Note that any heading (aka section title) that starts with equal signs is automatically an anchor.
+
+More info: http://asciidoctor.org/docs/user-manual/#internal-cross-references
+
+To link to another page or even a heading on _another page_, you use a similar syntax, but you must refer to the full filename and refer to the section title you want to link to by changing it to lower case and including hyphens between each word.
+
+For example, if I want to link from one page to the Schema API page's section "Modify the Schema", I need to create a link that looks like this:
+
+[source]
+For more information about modifying the schema with the API, see the section <<schema-api.adoc#modify-the-schema>>.
+
+You can add text to appear by adding it after the file name and section reference, as in:
+
+[source]
+<<schema-api.adoc#modify-the-schema,Modify the Schema>>
+
+More info: http://asciidoctor.org/docs/user-manual/#inter-document-cross-references
+
+== Item Lists
+
+Asciidoc supports three types of lists:
+
+* Unordered lists
+* Ordered lists
+* Labeled lists
+
+Each type of list can be mixed with the other types. So, you could have an ordered list inside a labeled list if necessary.
+
+=== Unordered Lists
+Simple bulleted lists need each line to start with an asterisk (`*`). It should be the first character of the line, and be followed by a space.
+
+More info: http://asciidoctor.org/docs/user-manual/#unordered-lists
+
+=== Ordered Lists
+Numbered lists need each line to start with a period (`.`). It should be the first character of the line, and be followed by a space.
+
+More info: http://asciidoctor.org/docs/user-manual/#ordered-lists
+
+=== Labeled Lists
+These are like question & answer lists or glossary definitions. Each line should start with the list item followed by double colons (`::`), then a space or new line.
+
+Labeled lists can be nested by adding an additional colon (such as `:::`, etc.).
+
+More info: http://asciidoctor.org/docs/user-manual/#labeled-list
+
+== Images
+
+There are two ways to include an image: inline or as a block.
+
+Inline images are those where text will flow around the image. Block images are those that appear on their own line, set off from any other text on the page.
+
+Both approaches use the `image` tag before the image filename, but the number of colons after `image` define if it is inline or a block. Inline images use one colon (`image:`), while block images use two colons (`image::`).
+
+Block images automatically include a caption label and a number (such as `Figure 1`). If a block image includes a title, it will be included as the text of the caption.
+
+Optional attributes allow you to set the alt text, the size of the image, if it should be a link, float and alignment.
+
+More info: http://asciidoctor.org/docs/user-manual/#images
+
+== Tables
+
+Tables can be complex, but it is pretty easy to make a basic table that fits most needs.
+
+=== Basic Tables
+The basic structure of a table is similar to Markdown, with pipes (`|`) delimiting columns between rows:
+
+[source]
+----
+|===
+| col 1 row 1 | col 2 row 1|
+| col 1 row 2 | col 2 row 2|
+|===
+----
+
+Note the use of `|===` at the start and end. For basic tables that's not exactly required, but it does help to delimit the start and end of the table in case you accidentally introduce (or maybe prefer) spaces between the rows.
+
+=== Header Rows
+To add a header to a table, you need only set the `header` attribute at the start of the table:
+
+[source]
+----
+[options="header"]
+|===
+| header col 1 | header col 2|
+| col 1 row 1 | col 2 row 1|
+| col 1 row 2 | col 2 row 2|
+|===
+----
+
+=== Defining Column Styles
+If you need to define specific styles to all rows in a column, you can do so with the attributes.
+
+This example will center all content in all rows:
+
+[source]
+----
+[cols="2*^" options="header"]
+|===
+| header col 1 | header col 2|
+| col 1 row 1 | col 2 row 1|
+| col 1 row 2 | col 2 row 2|
+|===
+----
+
+Alignments or any other styles can be applied only to a specific column. For example, this would only center the last column of the table:
+
+[source]
+----
+[cols="2*,^" options="header"]
+|===
+| header col 1 | header col 2|
+| col 1 row 1 | col 2 row 1|
+| col 1 row 2 | col 2 row 2|
+|===
+----
+
+Many more examples of formatting:
+
+* Columns: http://asciidoctor.org/docs/user-manual/#cols-format
+* Cells: http://asciidoctor.org/docs/user-manual/#cell
+
+=== More Options
+
+Tables can also be given footer rows, borders, and captions. CSV or DSV can be used instead of formatting the data in pipes.
+
+More info: http://asciidoctor.org/docs/user-manual/#tables
+
+== Admonitions (Notes, Warnings)
+
+Asciidoc supports several types of callout boxes, called "admonitions":
+
+* NOTE
+* TIP
+* IMPORTANT
+* CAUTION
+* WARNING
+
+It is enough to start a paragraph with one of these words followed by a colon (such as `NOTE:`). When it is converted to HTML or PDF, those sections will be formatted properly - indented from the main text and showing an icon inline.
+
+You can add titles to admonitions by making it an admonition block. The structure of an admonition block is like this:
+
+[source]
+----
+[NOTE]
+.Title of Note
+====
+Text of note
+====
+----
+
+In this example, the type of admonition is included in square brackets (`[NOTE]`), and the title is prefixed with a period. Four equal signs give the start and end points of the note text (which can include new lines, lists, etc.).
+
+More info: http://asciidoctor.org/docs/user-manual/#admonition

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/853c4ae0/solr/solr-ref-guide/meta-docs/editing-tools.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/meta-docs/editing-tools.adoc b/solr/solr-ref-guide/meta-docs/editing-tools.adoc
new file mode 100644
index 0000000..46a82ec
--- /dev/null
+++ b/solr/solr-ref-guide/meta-docs/editing-tools.adoc
@@ -0,0 +1,23 @@
+= Tools for Working with Asciidoc Format
+
+== Asciidoc vs Asciidoctor
+
+The Solr Ref Guide is written in _Asciidoc_ format. This format is generally considered an extension of Markdown, because it has support for tables of contents, better table support, and other features that make it more appropriate for writing technical documentation.
+
+We are using a version of the Asciidoc syntax along with tools from an open source project called https://asciidoctor.org[Asciidoctor]. This provides full support for the Asciidoc syntax, but replaces the original Python processor with one written in Ruby. There is a Java implementation, known as https://github.com/asciidoctor/asciidoctorj[AsciidoctorJ]. Further extensions from the original Asciidoc project include support for font-based icons and UI elements.
+
+== Helpful Tools
+
+You can write Asciidoc without any special tools. It's simply text, with familiar syntax for bold (`*`) and italics (`_`).
+
+Having some tools in your editor is helpful, though.
+
+=== Doc Preview
+
+This allows you to see your document in something close to what it might appear like when output to HTML.
+
+The following information is from http://asciidoctor.org/docs/editing-asciidoc-with-live-preview.
+
+* Atom has AsciiDoc Preview, which gives you a panel that updates as you type. There are also a couple of other plugins to support Asciidoc format and auto-complete.
+* There is a Live Preview browser plugin for Chrome, Firefox and Opera which allow you to open your Asciidoc page in the browser. It will also update as you type.
+* There is also an Intellij IDEA plugin to support Asciidoc format.