Skip to content

Commit 910b4ff

Browse files
JoanneOFlynn2018leifmadsenrheslop
authored
2129094 stf cleanup (#393)
* Inserted global folder * Updates to readme and master * REmoved collectd folder and stf-attributes * Updated docinfo * Removed link to collected plugins file from master * Update doc-Service-Telemetry-Framework/master.adoc Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/docinfo.xml Co-authored-by: Leif Madsen <[email protected]> * Update doc-Service-Telemetry-Framework/docinfo.xml Co-authored-by: Leif Madsen <[email protected]> * Update README.md * Update README.md * Update README.md Co-authored-by: Roger Heslop <[email protected]> * Update README.md * Update README.md * Update README.md * Apply suggestions from code review Delete ifeval statement for collectd reference file * Update common/global/stf-attributes.adoc Co-authored-by: Leif Madsen <[email protected]> Co-authored-by: Leif Madsen <[email protected]> Co-authored-by: Roger Heslop <[email protected]>
1 parent 369dce6 commit 910b4ff

15 files changed

+482
-2256
lines changed

‎README.md

+28-28
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ On MacOS, to install the required tools, use brew and replace the "make" command
1717

1818
brew install asciidoctor make
1919

20-
Alternatively, to make the "make" utility available on PATH, you can install the XCode development environment.
20+
Alternatively, you can install the XCode development environment so that the "make" utility is available on PATH.
2121
However, you must ensure you have several gigabytes of HDD space available and allow for approximately an hour to download and install the XCode development environment:
2222

2323
xcode-select --install
@@ -27,18 +27,18 @@ install it from rubygems:
2727

2828
gem install asciidoctor asciidoctor-pdf --pre
2929

30-
Run `make` or `make html` which builds HTML output. Generating
30+
Run `make` or `make html`, which builds HTML output. Generating
3131
PDF output is slow, therefore use the `make pdf` command separately. To
32-
make both formats in one command, use `make html pdf`. To build downstream
33-
version perform `make BUILD=downstream`.
32+
make both formats in one command, use `make html pdf`. To build a downstream
33+
version, run the `make BUILD=downstream browser` command.
3434

35-
Few additional make targets are available on the guide level. To build
36-
HTML version and open new tab in a browser, enter the following commands:
35+
Few additional `make` targets are available on the guide level. To build
36+
a HTML version and to view it in a new tab in a browser, enter the following commands:
3737

3838
cd doc-Service-Telemetry-Framework
3939
make browser
4040

41-
Similarly, to build and open PDF version, enter the following command:
41+
To build and open a PDF version, enter the following command:
4242

4343
make open-pdf
4444

@@ -49,31 +49,32 @@ rebuild use `make clean` to delete build directory and start over.
4949
## Reading or publishing
5050

5151
Publishing the upstream documentation is done automatically on merge to the
52-
`master` branch. Automation in Travis-CI will then result in a built html
52+
`master` branch. Automation in Travis-CI then results in a built HTML
5353
output that is pushed into the `gh-pages` branch. You can read the content at:
5454
https://infrawatch.github.io/documentation
5555

5656
## Contributing
5757

58-
Please read [Guidelines for Red Hat
59-
Documentation](https://redhat-documentation.github.io/) before opening a Pull
58+
Read [Guidelines for Red Hat Documentation](https://redhat-documentation.github.io/) before you open a Pull
6059
Request. Additional rules apply:
6160

6261
Never write "Service Telemetry Framework" or "STF" words directly but use the following variables:
6362

64-
| Variable | Upstream value | Downstream value |
65-
| -------- | -------------- | ---------------- |
66-
| Project | Service Telemetry Framework | Service Telemetry Framework |
67-
| ProjectShort | STF | STF |
68-
| OpenShift | OpenShift | Red Hat OpenShift Container Platform |
69-
| OpenShiftShort | OKD | OCP |
70-
| OpenStack | OpenStack | Red Hat OpenStack Platform |
71-
| OpenStackVersion | Train | 16 |
72-
| OpenStackLong | {OpenStack} {OpenStackVersion} | _same_ |
73-
| OpenStackInstaller | TripleO | Director |
74-
| OVirt | oVirt | Red Hat Virtualization |
75-
| OVirtShort | oVirt | RHV |
76-
| MessageBus | Apache Qpid Dispatch Router | AMQ Interconnect |
63+
| Variable | Upstream value | Downstream value |
64+
| -------- | -------------- | ---------------- |
65+
| Project | Service Telemetry Framework | Service Telemetry Framework |
66+
| ProjectShort | STF | STF |
67+
| OpenShift | OpenShift | Red Hat OpenShift Container Platform |
68+
| OpenStack | OpenStack | Red Hat OpenStack Platform |
69+
| OpenStackShort | OSP | RHOSP |
70+
| OpenStackVersion | Wallaby | 17.0 |
71+
| OpenStackLong | {OpenStack} {OpenStackVersion} | {OpenStack} {OpenStackVersion} |
72+
| OpenStackInstaller | TripleO | Director |
73+
| OVirt | oVirt | Red Hat Virtualization |
74+
| OVirtShort | oVirt | RHV |
75+
| MessageBus | Apache Qpid Dispatch Router | AMQ Interconnect |
76+
| SupportedOpenShiftVersion | 4.7 | 4.7 |
77+
| NextSupportedOpenShiftVersion | 4.8 | 4.8 |
7778

7879
Variables cannot be used in shell or code examples. To use them, use "attributes" keyword:
7980

@@ -82,16 +83,15 @@ Variables cannot be used in shell or code examples. To use them, use "attributes
8283
# ls {VariableName}
8384
----
8485

85-
Hide or show specific blocks, paragraphs, warnings or chapters via special
86-
variable called "build". Its value can be set either to "downstream" or
86+
Hide or show specific blocks, paragraphs, warnings or chapters by using a special
87+
variable called `build`. You can set the value of build to either "downstream" or
8788
"upstream":
8889

8990
ifeval::["{build}" == "upstream"]
9091
NOTE: This part is only relevant for deployments with Katello plugin.
9192
endif::[]
9293

93-
When performing a review, consider checking out the topic branch and putting necessary
94+
When you perform a review, check out the topic branch and put the necessary
9495
changes on top of the author's work instead of making many comments on github.
9596

96-
We should avoid using phases like, "Starting from version 6.5 or 1.22" because
97-
it is not possible to easily translate these strings in both the streams.
97+
Avoid using phases like "Starting from version 6.5 or 1.22" because it is not possible to easily translate these strings in both the streams.

‎common/collectd/con_data-collecting-agent.adoc

-28
This file was deleted.

‎common/collectd/proc_installing-collectd.adoc

-54
This file was deleted.

0 commit comments

Comments
 (0)