Skip to content

Commit 88c1a6c

Browse files
committed
Revert "Manual fixes for a number of rumdl warnings"
This reverts commit d58c30f.
1 parent 5ecd03f commit 88c1a6c

8 files changed

Lines changed: 21 additions & 18 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
* [Openshift](providers/openshift.md)
1414
* [Openstack Infra](providers/openstack_infra_provider.md)
1515
* [Interactive debugging with Pry-Remote](developer_setup/debugging.md)
16+
* [Running in minimal mode](developer_setup/minimal_mode.md)
1617
* [Running the test suites](developer_setup/running_test_suites.md)
1718
* [Running Cypress tests](ui/cypress.md)
1819
* [Setting up Kubernetes for use with ManageIQ](providers/kubernetes.md)
@@ -24,12 +25,14 @@
2425
* [Coding Style and Standards](coding_style_and_standards.md)
2526
* [Contributing to the API](https://github.com/ManageIQ/manageiq-api/blob/master/CONTRIBUTING.md)
2627
* [External Authentication (httpd)](external_auth.md)
28+
* [GIT Helpers](git_utils/README.md)
2729
* [Issue and PR Triage Process](triage_process.md)
2830
* [Internationalization Guidelines](i18n.md)
2931
* [Merger Guidelines](mergers_guidelines.md)
3032
* [Project Roadmap](https://github.com/orgs/ManageIQ/projects/13)
3133
* [Repository Labels and Colors](labels.md)
3234
* [Reviewer Guidelines](reviewers_guidelines.md)
35+
* [Sprint Boundaries](sprint_boundaries.md)
3336
* [UI Patterns](ui/patterns.md)
3437
* [UI Plugins](ui/plugins.md)
3538
* [Updating this Documentation](writing_guides.md)

architecture/enterprise.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ collisions when database synchronization combines the various regions into the
7373

7474
### Visual example
7575

76-
```text
76+
<pre>
7777
Region
7878
+--------------------------------------------------------------+
7979
| |
@@ -92,4 +92,4 @@ collisions when database synchronization combines the various regions into the
9292
| +--------------------------+ +--------------------------+ |
9393
| |
9494
+--------------------------------------------------------------+
95-
```
95+
</pre>

architecture/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
ManageIQ uses the standard Ruby [Logger](https://ruby-doc.org/stdlib-2.6.6/libdoc/logger/rdoc/Logger.html)
44
interface, with a custom formatter that is mostly just minor changes from the
55
default formatter. Additionally, we use a logger abstraction library, called
6-
[manageiq-loggers](https://github.com/ManageIQ/manageiq-loggers) in order to support
6+
[manageiq-loggers](github.com/ManageIQ/manageiq-loggers) in order to support
77
multiple log targets and formats.
88

99
An example log message looks like:

architecture/source_code_layout.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ManageIQ is a Rails application with the following standard layout
1717
| Rakefile | This file locates and loads tasks that can be run from the command line. The task definitions are defined throughout the components of Rails. Rather than changing Rakefile, you should add your own tasks by adding files to the lib/tasks directory of your application. |
1818
| README.md | Overview of the ManageIQ project. |
1919
| [spec/](#spec) | Tests using RSpec. |
20-
| tools | Special purpose Ruby scripts that should not be executed without full understanding of what they do. |
20+
| [tools/](#tools) | Special purpose Ruby scripts that should not be executed without full understanding of what they do. |
2121
| tmp/ | Temporary files (like cache, pid, and session files). |
2222
| vendor/ | A place for all third-party code. |
2323

proposals/automate_model_redesign.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ The Automate Model has grown to be a very large and central piece of ManageIQ. T
1818
## Proposal
1919

2020
* Provide clear separation between core automate model and user space where built-in automate methods are viewable but read-only. Allow end users to duplicate built-in automate model objects and utilize them. Any modifications that bridge core automate and user space must survive model upgrade.
21-
* Reorganize classes and folders logically. [See proposal below](#proposed-namespaceclass-restructure).
21+
* Reorganize classes and folders logically. [See proposal below](Automate-Model-Redesign#proposed-namespaceclass-restructure).
2222
* Reorganize integration namespace to be a central place for all customer integration
2323
* Enable text-based editing through familiar directory hierarchy and files (see below)
24-
* schema: YAML syntax. [example](#proposed-example-schemayaml)
24+
* schema: YAML syntax. [example](Automate-Model-Redesign#proposed-example-schemayaml)
2525
* methods: ruby files
2626
* Provide command-line simulation tool for complete CLI-based development/debugging workflow. This will also provide a tool for automated testing.
2727
* Automate hierarchy should have a view of the "community" models which may be selected and imported into ManageIQ. See planned [Github space](https://github.com/RedHatIntegrate/CloudForms-Management-Engine) for community models.

providers/kubernetes.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,33 +31,33 @@ Based on instructions for deploying Kubernetes manually from here: <https://kube
3131

3232
Ensure the following conditions are met:
3333

34-
1. In `/etc/kubernetes/kubelet`, ensure `KUBELET_ARGS` contains `--allow-privileged`
35-
2. On the master node, generate a default serviceaccount key with `openssl genrsa -out /tmp/serviceaccount.key 2048`
36-
3. In `/etc/kubernetes/apiserver`, ensure `KUBE_API_ARGS` contains `--service_account_key_file=/tmp/serviceaccount.key` (or the correct path to your default serviceaccount key).
37-
4. In `/etc/kubernetes/apiserver`, ensure `KUBE_API_ARGS` contains `--allow-privileged`
34+
0. In `/etc/kubernetes/kubelet`, ensure `KUBELET_ARGS` contains `--allow-privileged`
35+
0. On the master node, generate a default serviceaccount key with `openssl genrsa -out /tmp/serviceaccount.key 2048`
36+
0. In `/etc/kubernetes/apiserver`, ensure `KUBE_API_ARGS` contains `--service_account_key_file=/tmp/serviceaccount.key` (or the correct path to your default serviceaccount key).
37+
0. In `/etc/kubernetes/apiserver`, ensure `KUBE_API_ARGS` contains `--allow-privileged`
3838

3939
### Prepare cluster for use with ManageIQ
4040

41-
1. Create `management-infra` namespace:
41+
0. Create `management-infra` namespace:
4242

4343
```bash
4444
kubectl create ns management-infra
4545
```
4646

47-
2. Create required serviceaccounts:
47+
0. Create required serviceaccounts:
4848

4949
```bash
50-
kubectl create sa -n management-infra management-admin
51-
kubectl create sa -n management-infra inspector-admin
50+
kubectl create sa -n management-infra management-admin
51+
kubectl create sa -n management-infra inspector-admin
5252
```
5353

54-
3. Grant cluster-reader cluster role to `management-admin` SA:
54+
0. Grant cluster-reader cluster role to `management-admin` SA:
5555

5656
```bash
5757
kubectl create clusterrolebinding management-infra-cluster-reader --clusterrole=cluster-reader --user=system:serviceaccount:management-infra:management-admin
5858
```
5959

60-
4. Retrieve the serviceaccount token for `management-admin` (this will be the auth token ManageIQ uses):
60+
0. Retrieve the serviceaccount token for `management-admin` (this will be the auth token ManageIQ uses):
6161

6262
```bash
6363
kubectl describe secret -n management-infra $(kubectl get secrets -n management-infra | grep management-admin | cut -f1 -d ' ') | grep -E '^token' | cut -f2 -d':' | tr -d '\t'

providers/subclassing_an_existing_provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Follow the steps from [Creating a new provider](writing_a_new_provider.md) for s
5959

6060
You'll notice however that we chose "--no-scaffolding" option, this is going to allow us to define the classes that we need as subclasses of the OpenStack provider.
6161

62-
### Creating the Manager class
62+
### Creating the subclasses
6363

6464
Now that we have an empty plugin we have to start adding the subclasses that we need for the provider to work.
6565

ui/menus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Menu sections looks like the example above. It consists of:
2424

2525
Identifier is the same as the [RBAC feature](rbac_features.md) that is checked when a decision is made whether or not the particular section is displayed.
2626

27-
Text needs to be marked for translation but not translated at the time of definition, therefor ``N_`` see [I18n](../i18n.md)
27+
Text needs to be marked for translation but not translated at the time of definition, therefor ``N_`` see [I18n](i18n.md)
2828

2929
Menu section structure (tree) forms the base of the RBAC tree that is available in the Role Editor. (See [RBAC features](rbac_features.md).)
3030

0 commit comments

Comments
 (0)