docs: Fixup several minor issues#203
Conversation
NickVolynkin
force-pushed
the
nickvolynkin-fixup
branch
from
fb16e69 to
4995abc
Compare
Provided example is using a space name alone, without network. It's a special case which is described in the CLI help, but wasn't explained in this guide. docs: Fixup `sunbeam deployment space map` syntax example Resolve canonical#153 Resolve canonical#158
Resolve canonical#179 Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Cinder configuration key `san-username` was replaced with `san-login` to match the updated key in Sunbeam. See: - https://github.com/canonical/snap-cinder-volume#dell-sc-backend - https://github.com/canonical/snap-cinder-volume#hitachi-backend Resolve canonical#185 Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
NickVolynkin
force-pushed
the
nickvolynkin-fixup
branch
from
0d94e2c to
9bf73f5
Compare
Resolve canonical#201 Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
NickVolynkin
force-pushed
the
nickvolynkin-fixup
branch
from
9366137 to
e92cfb0
Compare
| ^^^^^ | ||
|
|
||
| `Snaps <https://snapcraft.io/docs>`_ are application container images that are designed to be strictly confined and secure by default. Canonical OpenStack uses snaps for the purpose of hosting OpenStack's data plane processes as well as many other software components being used in the RA. | ||
| `Snaps <https://snapcraft.io/docs>`_ are application container images that are designed to be strictly confined and secure by default. Canonical OpenStack uses snaps for the purpose of hosting OpenStack's data plane processes as well as many other software components being used in the Reference Architecture (RA). |
There was a problem hiding this comment.
I could add a link to https://ubuntu.com/engage/canonical-openstack-reference-architecture, but I'm not sure whether linking from docs to marketing materials fits the Canonical style guide.
|
|
||
| ``NETWORK`` is the cloud network (a traffic group). | ||
|
|
||
| If a space is given alone, it will be considered as the default space. |
There was a problem hiding this comment.
Without this extra explanation, the example below is unclear.
| physnet: <physnet-name> | ||
|
|
||
| # External networking (deprecated) | ||
| # External networking (deprecated, use external_networks instead) |
There was a problem hiding this comment.
Let's consider removing external_network completely or at least moving it below external_networks
| # hostname: public.openstack.example.com | ||
| # ingress-rgw: | ||
| # ip: 192.168.29.28 | ||
| endpoints: |
There was a problem hiding this comment.
The whole block had wrong indentation, so when you copy and paste it, the IDE shows a YAML syntax error.
There was a problem hiding this comment.
In general, editing the manifest sample is difficult because it's inlined. I propose extracting it into a separate YAML file and then including it in the page. I can do it if maintainers approve.
| <option1>: <value> | ||
| <option2>: <value> |
There was a problem hiding this comment.
YAML can't have two keys with the same names. (Because a dict can't). It's best if the example is a valid YAML file.
| <CSR x500UniqueIdentifier>: | ||
| # Base64 encoded certificate for unit CSR Unique ID: subject | ||
| certificate: <Base64 encoded certificate> | ||
| ... |
There was a problem hiding this comment.
I wasn't sure what exactly it means here. One more certificate?
|
@gboutry, I've fixed a number of minor issues in the docs. Please take a look. |
| addons: | ||
| metallb: 192.168.123.81-192.168.123.90 | ||
| k8s-addons: | ||
| metallb: 192.168.123.81-192.168.123.90 |
There was a problem hiding this comment.
I think this should be loadbalancer, not metallb
Update a manifest to match the current state. Resolve canonical#189 Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
Resolve canonical#152 Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
- Fixup indentation - Use different placeholder names for sibling keys - Comment or remove the `...` fragments Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
NickVolynkin
force-pushed
the
nickvolynkin-fixup
branch
from
e92cfb0 to
30f2350
Compare
2 participants
See the commit messages for details on each change.
Resolve #152
Resolve #153
Resolve #158
Resolve #179
Resolve #185
Resolve #189
Resolve #201