Merge pull request #1 from ncbaratta/setup

seed the repo

common/attributes.adoc

@@ -1 +1,98 @@
-//Attributes
+// Our docinfo.xml
+:docinfo:
+
+// AsciiDoc rendering
+:source-highlighter: prettify
+:last-update-label!:
+:attribute-missing: warn
+:experimental:
+
+// Guide directory structure
+:imagesdir: images
+:filesdir: files
+
+// special chars
+:cpp: C++
+
+// Platforms
+:rh: Red{nbsp}Hat
+:rhel: {rh} Enterprise{nbsp}Linux
+:mac: macOS
+:fed: Fedora
+:msw: Microsoft Windows
+:ocp: OpenShift Container Platform
+:osd: OpenShift Dedicated
+:rhocp: {rh} {ocp}
+:rhcc: {rh} Container Catalog
+:rhcc-url: registry.access.redhat.com
+:rhcp: {rh} Customer Portal
+:rhsm: Red{nbsp}Hat Subscription Management
+:rhio-url: registry.redhat.io
+
+// OpenShift versions
+:ocp-ver: 3.11
+:osd-ver: 3.11
+
+// prod naming, versions
+:prod: {rh} Developer Tools
+:prod-ver: 2019.2
+
+// devstudio naming
+:devstudio: Developer{nbsp}Studio
+:rhdevstudio: {rh} {devstudio}
+:devstudio-ver: 12.11
+:rhdevstudio-ver: {rhdevstudio}{nbsp}{devstudio-ver}
+
+// OpenJDK naming & version
+:java-ver: Java{nbsp}8
+:jdk: OpenJDK
+:jdk-ver: 1.8.0_131
+
+//OpenJDK Product
+:prod: OpenJDK
+:comp-ver: 11
+:prod-ver: {comp-ver}
+:comp-ver-full: {comp-ver}.0.3
+:comp: {prod} {comp-ver} for Windows
+:openjdk-ver: {comp-ver-full}
+
+:openjdk-download-url: https://developers.redhat.com/products/openjdk/download/
+
+// CDK naming, version
+:rhcdk: {rh} Container{nbsp}Development{nbsp}Kit
+:cdk-ver: 3.2
+:rhcdk-ver: {rhcdk}{nbsp}{cdk-ver}
+
+// Developer Toolset
+:dts: {rh} Developer{nbsp}Toolset
+:dts-ver: 8
+:rhscl: {rh} Software{nbsp}Collections
+
+// RH docs
+:acc-rh-com-docs: https://access.redhat.com/documentation/en-us
+
+// RHSM docs
+:rhsm-docs-url: {acc-rh-com-docs}/red_hat_subscription_management
+
+// devstudio guide names and URLs
+:rhdevstudio-rn: {rhdevstudio-ver} Release Notes
+:rhdevstudio-rn-url: {acc-rh-com-docs}/red_hat_jboss_developer_studio/{devstudio-ver}/html-single/release_notes_and_known_issues/
+:rhdevstudio-ig: {rhdevstudio-ver} Installation Guide
+:rhdevstudio-ig-url: {acc-rh-com-docs}/red_hat_jboss_developer_studio/{devstudio-ver}/html-single/installation_guide/
+:rhdevstudio-gs-cloud: Getting Started with Container and Cloud-based Development
+:rhdevstudio-gs-cloud-url: {acc-rh-com-docs}/red_hat_jboss_developer_studio/{devstudio-ver}/html-single/getting_started_with_container_and_cloud-based_development/
+:rhdevstudio-gs-cloud-paged-url: {acc-rh-com-docs}/red_hat_jboss_developer_studio/{devstudio-ver}/html/getting_started_with_container_and_cloud-based_development/
+
+:!isbeta:
+// define (no !) or undefine (line starts with :!)
+
+ifdef::isbeta[]
+:dashbeta: -beta
+endif::[]
+ifndef::isbeta[]
+:dashbeta:
+endif::[]
+
+// DTS User Guide docs URL
+// NOTE: Makes use of {dashbeta} defined above, thus its placement here.
+:dts-ug-docs-url: {acc-rh-com-docs}/red_hat_developer_toolset/{dts-ver}{dashbeta}/html/user_guide

contributing/common

@@ -0,0 +1 @@
+../common

contributing/contributor-guide.adoc

@@ -0,0 +1,79 @@
+[[contributing-to-docs]]
+= Contributing to the documentation
+
+The following guide walks you through contributing to the OpenJDK documentation.
+
+[[contribution-getting-started]]
+== Getting started
+
+Before you begin you need to:
+
+. xref:setting-up-git[Install and set up Git]
+
+[[contributing]]
+== Contributing to the documentation
+
+Once you have your local repository set up and have up to date copies of upstream content you need to follow these steps to contribute to the documentation.
+
+.Procedure
+. Open your terminal
+. `cd` to the directory where your documentation resides
+. Checkout the master branch
++
+[source]
+----
+$ git checkout master
+----
+. Update your local repository and fork with the upstream content
++
+[source]
+----
+$ git pull upstream master
+$ git push origin master --force
+----
+. Create a new branch for your work (using the issue number is helpful)
++
+[source,options="nowrap",subs="+quotes"]
+----
+$ git checkout -b <branch-name>
+----
+. Make your edits in the editor of your choice
+. Save your changes locally
+. If you are creating new files, add the files to the repository
++
+[source,options="nowrap",subs="+quotes"]
+----
+$ git status
+$ git add <file-name>
+----
+
+. Commit your changes
++
+[source,options="nowrap",subs="+quotes"]
+----
+$ git commit -a -m "<message>"
+----
+. Push your changes to your fork
++
+[source]
+----
+$ git push origin HEAD
+----
+. If the update is rejected because the commit is behind, merge your changes
++
+[source]
+----
+$ git pull upstream master
+$ git push -f origin HEAD
+----
+. Visit your fork on GitHub
+. Click *Compare & pull request*
+. If a SME review is needed:
+.. Add *SME Review Needed* label.
+.. When SME review is complete, remove *SME Review Completed* label and go to step 16.
+. Add *Peer Review Needed* label and assign a Reviewer.
+.. When peer review has been completed, the reviewer deletes the *Peer Review Needed* label and adds the *Peer Review Done* label.
+. When *Peer Review Done* label has been added:
+.. If no changes are needed, remove *Peer Review Done* label and add *Ready for Merge* label.
+.. If changes are needed and the changes are minor, make changes to the files, commit, and push, and then remove *Peer Review Done* label and add *Ready for Merge* label.
+.. If you want an additional review on the updated content, add the *Peer Review Needed* label and ask for another review in a comment.

contributing/files.adoc

@@ -0,0 +1,45 @@
+[[files-and-attributes]]
+= Files and attributes
+
+== Important files
+
+|===
+| Standard attributes         | common/attributes.adoc
+| Shared includes             | common/
+| Images                      | images/
+|===
+
+[[anchor-and-file-names]]
+== Anchor names and file names
+
+To optimize modular documentation, follow these guidelines for naming module anchors and files:
+
+Anchor names:: Provide an anchor in the format `++[id='anchor-name']++` for every module so that it can be identified by Asciidoctor when reused or cross-referenced. Give the anchor the same or similar name as the module heading, separated by dashes:
++
+[source]
+----
+[id='anchor-name']
+= Module Heading
+
+First sentence of topic.
+----
++
+[NOTE]
+.Note on other anchor formats (Not Recommended)
+====
+The format defined here is recommended because it is the most stable and versatile of anchor formats, and supports variables that enable topics to be reused and cross-referenced properly. Other anchor formats include `\[[anchor-name]]` and `+[#anchor-name]+`, but these formats either do not support variables for content reuse or do not support certain character types, such as periods. These limitations cause errors at build time.
+====
+
+File names:: Give the module file the same name as the anchor used in it (which is the same as or similar to the module heading), also separated by dashes. Add a prefix with an underscore to the file name to indicate the module type in the format `prefix-file-name`. Use `snip-` for a snippet, `con-` for concept, `ref-` for reference, `proc-` for procedure, `assembly-` for assembly, and `image-` for images and screenshots.
++
+.Examples
+* `snip-guided-decision-urls.adoc`  (Snippet of reusable content)
+* `con-guided-decision-tables.adoc`  (Concept module)
+* `proc-creating-guided-decision-tables.adoc`  (Procedure module for creating)
+* `proc-editing-guided-decision-tables.adoc`  (Procedure module for editing)
+* `ref-guided-decision-table-examples.adoc`  (Reference module with examples)
+* `ref-guided-decision-table-columns.adoc`  (Reference module with column types)
+* `assembly-guided-decision-tables.adoc`  (Assembly of guided decision table modules)
+* `image-guided-decision-example.adoc`  (Screenshot or image of guided decision table modules)
+
+Learn more in the link:https://redhat-documentation.github.io/modular-docs/[Modular Documentation Reference Guide^].

contributing/formatting-guide.adoc

@@ -0,0 +1,37 @@
+[[formatted-text-reference]]
+= AsciiDoc format reference
+
+Tips for which AsciiDoc markup to use when formatting text.
+
+Monospace (```)::
+[cols="50%,50%",options="header"]
+|===
+|Item |Example
+|File names and paths |The \`/home/user/.bashrc` file ...
+|Literal values | If the value is \`true` ...
+|Configuration attributes | Set the \`enabled` attribute ...
+|Java class names |The \`java.sql.Connection` class ...
+|Java annotations |The \`@Clustered` annotation ...
+|===
+
+Italics (`_`)::
+[cols="50%,50%",options="header"]
+|===
+|Item |Example
+|Guide titles |See the \_Installation Guide_ ...
+|Emphasis for a term _(only emphasize first time)_ |\_High availability_ refers to the ...
+|===
+
+Bold (`*`)::
+[cols="50%,50%",options="header"]
+|===
+|Item |Example
+|GUI items _(menus, buttons)_|Click the \*Add* button and ...
+|===
+
+Underline (`[.underline]#value#`)::
+[cols="50%,50%",options="header"]
+|===
+|Item |Example
+|Default item in a multi-select|\`yes\|[.underline]\#no#\|maybe`
+|===