Skip to content

Commit

Permalink
4.1 GA
Browse files Browse the repository at this point in the history
  • Loading branch information
vikram-redhat committed Jun 4, 2019
1 parent ca69ca6 commit b342a11
Show file tree
Hide file tree
Showing 9 changed files with 165 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .s2i/httpd-cfg/01-commercial.conf
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ AddType text/vtt vtt

# Redirects for "latest" version
RewriteRule ^(container-platform|enterprise)/?$ /container-platform/latest [R=301]
RewriteRule ^(container-platform|enterprise)/latest/?(.*)$ /container-platform/3\.11/$2 [NE,R=301]
RewriteRule ^(container-platform|enterprise)/latest/?(.*)$ /container-platform/4\.1/$2 [NE,R=301]
RewriteRule ^(dedicated|online)/(3\.0|3\.1|3\.2|3\.3|3\.4|3\.5|3\.6|3\.7|3\.9|3\.10|3\.11|latest)/?(.*)$ /$1/$3 [NE,R=301]

# Welcome page redirects
Expand Down
8 changes: 4 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
language: python
python:
python:
- 2.7

cache: pip
Expand All @@ -15,9 +15,9 @@ install:
- pip install aura.tar.gz

script:
- python build.py --distro openshift-enterprise --product "OpenShift Container Platform" --version 3 --no-upstream-fetch
- if [ "$TRAVIS_BRANCH" == "enterprise-3.9" ] || [ "$TRAVIS_BRANCH" == "enterprise-3.10" ] || [ "$TRAVIS_BRANCH" == "enterprise-3.11" ]; then python build.py --distro openshift-online --product "OpenShift Container Platform" --version 3 --no-upstream-fetch; fi
- if [ "$TRAVIS_BRANCH" == "enterprise-3.9" ] || [ "$TRAVIS_BRANCH" == "enterprise-3.10" ] || [ "$TRAVIS_BRANCH" == "enterprise-3.11" ]; then python build.py --distro openshift-dedicated --product "OpenShift Container Platform" --version 3 --no-upstream-fetch; fi
- python build.py --distro openshift-enterprise --product "OpenShift Container Platform" --version 4.1 --no-upstream-fetch
- if [ "$TRAVIS_BRANCH" == "enterprise-3.11" ]; then python build.py --distro openshift-online --product "OpenShift Container Platform" --version 3 --no-upstream-fetch; fi
- if [ "$TRAVIS_BRANCH" == "enterprise-3.11" ]; then python build.py --distro openshift-dedicated --product "OpenShift Container Platform" --version 3 --no-upstream-fetch; fi
- python makeBuild.py

after_success:
Expand Down
40 changes: 39 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
= OpenShift Documentation

Welcome to the OpenShift documentation GitHub repository. To contribute to OpenShift docs, see https://github.com/openshift/openshift-docs/blob/enterprise-4.1/contributing_to_docs/contributing.adoc
* https://www.okd.io/[OKD]
* https://www.openshift.com/products/online/[OpenShift Online]
* https://www.openshift.com/products/container-platform/[OpenShift Container Platform]
* https://www.openshift.com/products/dedicated/[OpenShift Dedicated]
All OpenShift documentation is sourced in http://www.methods.co.nz/asciidoc/[AsciiDoc] and transformed into HTML/CSS and other formats through automation that is based on http://asciidoctor.org/[AsciiDoctor].

The documentation published from these source files can be viewed at http://docs.openshift.com.

== Contributing to OpenShift documentation
If you are interested in contributing to OpenShift technical documentation, you can view all our link:./contributing_to_docs[resources] that will help you get set up and provide more information.


The following table provides quick links to help you get started.

[options="header"]
|===

|Question |Link

|I'm interested, how do I contribute?
|See the link:/contributing_to_docs/contributing.adoc[contributing] topic to learn more about this repository and how you can contribute.

|Are there any basic guidelines to help me?
|The link:/contributing_to_docs/doc_guidelines.adoc[documentation guidelines] topic provides some basic guidelines to help us keep our content consistent, and includes other style information.

|How do I set up my workstation?
|See the link:/contributing_to_docs/tools_and_setup.adoc[tools and setup] topic to set up your workstation.

|How do I edit an existing topic, or create new content?
|See the link:/contributing_to_docs/create_or_edit_content.adoc[create or edit content] topic to get started.

|===

== Contacts

For questions or comments about OpenShift documentation:

* Send an email to the OpenShift documentation team at [email protected].
12 changes: 0 additions & 12 deletions _templates/_page_openshift.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
<meta charset="utf-8">
<meta content="IE=edge" http-equiv="X-UA-Compatible">
<meta content="width=device-width, initial-scale=1.0" name="viewport">
<!-- change this when 4.1 docs are released -->
<%= (version == "4.1") ? '<meta name="robots" content="noindex,nofollow">' : '' %>
<title><%= [topic_title, subgroup_title].compact.join(' - ') %> | <%= group_title %> | <%= distro %> <%= version %></title>
<link href="https://assets.openshift.net/content/subdomain.css" rel="stylesheet" type="text/css">
<link href="<%= File.join(css_path, 'docs.css') %>" rel="stylesheet" />
Expand Down Expand Up @@ -85,8 +83,6 @@
</ol>
<div class="row row-offcanvas row-offcanvas-left">
<div class="col-xs-8 col-sm-3 col-md-3 sidebar sidebar-offcanvas">
<!-- change this when 4.1 docs are released -->
<% if (version != "4.1") %>
<div class="row-fluid">
<div id="hc-search">
<input id="hc-search-input" type="text">
Expand All @@ -100,20 +96,12 @@
</div>
</div>
</div>
<% end %>
<%= render("_templates/_nav_openshift.html.erb", :distro_key => distro_key, :navigation => navigation, :group_id => group_id, :topic_id => topic_id, :subgroup_id => subgroup_id, :subtopic_shim => subtopic_shim) %>
</div>
<div class="col-xs-12 col-sm-9 col-md-9 main">
<div class="page-header">
<h1><%= article_title %></h1>
</div>
<% if (version == "4.1") %>
<font size="+1" color="red">This documentation is for Beta only and might not be complete or fully tested.</font>
<div id="annoying-box"
style="position: fixed; top: 100px; left: 10px; width: 100px; height: 100px; color: red">
This documentation is for Beta only and might not be complete or fully tested.
</div>
<% end %>
<%= content %>
</div>
</div>
Expand Down
20 changes: 13 additions & 7 deletions contributing_to_docs/contributing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ contain all the images and modules for the collection.
----

== Version management
Most of the content applies to all four OpenShift products: OKD, OpenShift
Online, OpenShift Dedicated, and OpenShift Container Platform. While a large
Most of the content applies to all five OpenShift products: OKD, OpenShift
Online, OpenShift Dedicated, Azure Red Hat OpenShift and OpenShift Container Platform. While a large
amount of content is reused for all product collections, some information
applies to only specific collections. Content inclusion and exclusion is managed
on the assembly level by specifying distributions in the
Expand Down Expand Up @@ -88,6 +88,7 @@ are:
* _openshift-online_
* _openshift-enterprise_
* _openshift-dedicated_
* _openshift-aro_

These attributes can be used by themselves or in conjunction to conditionalize
text within a topic document.
Expand Down Expand Up @@ -128,26 +129,31 @@ OpenShift products. However, when and as new versions of an OpenShift product
are released, the `master` branch is merged down to new or existing release
branches. Here is the general naming scheme used in the branches:

* `master` - OKD latest code; essentially, this is our *working*
branch.
* `master` - This is our *working* branch.
* `master-3` - OKD latest code; essentially, this is our *working*
branch for the 3.x stream.
* `enterprise-N.N` - OpenShift Container Platform support releases. The docs
for OpenShift Online and OpenShift Dedicated are based on the appropriate
`enterprise-N.N` branch.

On a 6 hourly basis, the documentation web sites are rebuilt for each of these
On a 12 hourly basis, the documentation web sites are rebuilt for each of these
branches. This way the published content for each released version of an
OpenShift product will remain the same while development continues on the
`master` branch. Additionally, any corrections or additions that are
"cherry-picked" into the release branches will show up in the published
documentation after 6 hours.
documentation after 12 hours.

[NOTE]
====
All OpenShift content development occurs on the `master`, or *working* branch.
All OpenShift content development for the 4.x stream occurs on the `master`, or
*working* branch.
Therefore, when submitting your work the PR must be created against the `master`
branch. After it is reviewed, a writer will apply the content to the relevant
release branches. If you know which branches a change applies to, be sure to
specify it in your PR.
We have a separate master branch for 3.x stream of OpenShift: master-3. You
should submit content against that branch for changes to 3.x stream.
====

== Adding files to the collection
Expand Down
97 changes: 97 additions & 0 deletions contributing_to_docs/contributing_user_stories.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
[[contributing-user-stories]]
= Contribute user stories to OpenShift documentation
:icons:
:toc: macro
:toc-title:
:toclevels: 1
:description: Basic information about how to create user stories for OpenShift GitHub repository

toc::[]

== Modularization backstory
OpenShift docs are getting modularized, starting from OpenShift 4.1.
All existing content will be completely replaced with content that is based on user stories and
complies with the modularization guidelines. All future content must both
support a user story and be modular.

== How do I contribute modularized content?
To contribute modularized content, you need to write a user story, create
documentation modules to support the user story, and create an assembly for the
story.

== What if I don't want to write in modules?
If you don't want to write the modules yourself but have a content change,
write a user story, provide details to support the story, and reach out to the
OpenShift docs team.

== How do I write a user story? Is there a template?
Instead of a template, we have a series of questions for you to answer to
create the user story. Follow the same steps if you are writing the modules
yourself or if you plan to work with the docs team.

The basic format of a user story is:

----
As a <type of user>, I want to <goal state> because <reason behind the goal>.
----

For example, "As a cluster administrator, I want to enable an Auto Scaling group to manage my OpenShift Enterprise
cluster deployed on AWS because I want my node count to scale based on application demand."

Use the following questions to guide you in providing the context for your user story and the necessary technical details to start a draft.
You don't have to answer all of these questions, only the ones that make sense to your particular user story.

=== Feature info
* What is the feature being developed? What does it do?
* How does it work?
* Are there any configuration files/settings/parameters being added or modified? Are any new commands being added or modified?
* What tools or software does the docs team need to test how this feature works? Does the docs team need to update any installed software?
* Are there any existing blogs, Wiki posts, Kbase articles, or Bzs involving this feature? Or any other existing information that may help to understand this feature?

=== Customer impact
* Who is the intended audience for this feature? If it's for Enterprise, does it apply to developers, admins, or both?
* Why is it important for our users? Why would they want to use this feature? How does it benefit them?
* How will the customer use it? Is there a use case?
* How will the customer interact with this feature? Client tools? Web console? REST API?

=== Product info
* Is this feature being developed for Online? Enterprise? Dedicated? OKD? All?
* Will this feature be rolled back to previous versions?
* If it's for Online, what type of plan do users need to use this feature?
* Is it user-facing, or more behind-the-scenes admin stuff?
* What tools or software does the docs team need to test how this feature works?

== How do I write in modules?
The full guidelines for writing modules are in the Customer Content Services (CCS)
link:https://redhat-documentation.github.io/modular-docs/[modularization guide].

The main concepts of writing in modules are:

* Each assembly contains the information required for a user to achieve a single
goal.
* Assemblies contain primarily `include` statements, which are references to
smaller, targeted module files.
* Modules can contain conceptual information, reference information, or steps,
but not a combination of the types.

For example, a simple assembly might contain the following three modules:

* A concept module that contains background information about the feature
that the user will configure
* A reference module that contains an annotated sample yaml file that the user
needs to modify
* A procedure module that contains the prerequisites that the user needs to
complete before they start configuring and steps that the user takes to
complete the configuration.

The `enterprise-4.1` branch contains sample assemblies that explain how to
get started with modular documentation for OpenShift and that serve as
references for including modules in assemblies. The
link:https://raw.githubusercontent.com/openshift/openshift-docs/enterprise-4.1/mod_docs_guide/mod-docs-conventions-ocp.adoc[Modular Docs OpenShift conventions]
assembly contains the
link:https://raw.githubusercontent.com/openshift/openshift-docs/enterprise-4.1/modules/mod-docs-ocp-conventions.adoc[Modular docs OpenShift conventions]
reference module, and the
link:https://github.com/openshift/openshift-docs/blob/enterprise-4.1/mod_docs_guide/getting-started-modular-docs-ocp.adoc[Getting started with modular docs on OpenShift]
assembly contains the
link:https://raw.githubusercontent.com/openshift/openshift-docs/enterprise-4.1/modules/creating-your-first-content.adoc[Creating your first content]
procedure module.
11 changes: 8 additions & 3 deletions contributing_to_docs/create_or_edit_content.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,13 @@ with the remote repository.
[NOTE]
====
Because most changes in this repository must be committed to the `master`
branch, the following process always uses `master` as the name of the source
branch (which is the master for the 4.x stream), the following process always
uses `master` as the name of the source
branch. If you must use another branch as the source for your change, make
sure that you consistently use that branch name instead of `master`
sure that you consistently use that branch name instead of `master`.
More importantly, if your changes apply to the 3.x stream, use master-3 as the
source branch.
====

1. From your local repository, make sure you have the `master` branch checked
Expand Down Expand Up @@ -113,7 +117,8 @@ $ git commit -am "Detailed comments about what changes were made; for example, f
*Step 5:* Rebase updates from `master` into your working branch

Remember that you must rebase against the branch that you created this working
branch from. In most cases, it will be the master branch.
branch from. In most cases, it will be the master branch for the 4.x stream and
master-3 for the 3.x stream.

----
$ git rebase upstream/master
Expand Down
2 changes: 1 addition & 1 deletion contributing_to_docs/term_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

NOTE: The guidelines in this branch are specific for OpenShift / OKD 4.x
documentation. See the
link:https://github.com/openshift/openshift-docs/tree/master/contributing_to_docs[`master` branch]
link:https://github.com/openshift/openshift-docs/tree/master-3/contributing_to_docs[`master-3` branch]
for guidelines for OpenShift / OKD 3.x documentation.

toc::[]
Expand Down
2 changes: 2 additions & 0 deletions index-commercial.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ <h2>OpenShift Container Platform</h2>
<div class="btn-group">
<button type="button" class="btn btn-primary dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Select Version<span class="caret"></span></button>
<ul class="dropdown-menu" role="menu">
<li><a href="container-platform/4.1/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 4.1</a></li>
<li><a href="container-platform/3.11/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 3.11</a></li>
<li><a href="container-platform/3.10/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 3.10</a></li>
<li><a href="container-platform/3.9/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 3.9</a></li>
<li><a href="container-platform/3.7/"><i class="fa fa-arrow-circle-o-right"></i> Container Platform 3.7</a></li>
Expand Down

0 comments on commit b342a11

Please sign in to comment.