This reverts commit 8ff1cee1ce
(2018-09-28, #370).
We moved from Glide to dep in 1f455431 (vendor: switch from glide to
dep, 2018-09-28, #380), so we no longer need to worry about yamllint
vs. Glide.yaml.
Temporarily make the script a no-op while we work out whether we want
to keep this. It's currently complaining about the YAML output from
Glide in the previous commit [1]:
./glide.yaml
1:1 warning missing document start "---" (document-start)
3:1 error wrong indentation: expected 2 but found 0 (indentation)
5:1 error wrong indentation: expected 2 but found 0 (indentation)
38:1 error wrong indentation: expected 2 but found 0 (indentation)
Dropping the script entirely would break CI [2]. Alex is ok dropping
yamllint entirely, but I'm half-interested in keeping it around in
case we decide to move any static YAML assets
(e.g. pkg/asset/manifests/content/tectonic/rbac/role-user.go) over
into data/data.
[1]: https://storage.googleapis.com/origin-ci-test/pr-logs/pull/openshift_installer/370/pull-ci-openshift-installer-yaml-lint/636/build-log.txt
[2]: d7ea5b36da/ci-operator/jobs/openshift/installer/openshift-installer-master-presubmits.yaml (L354)
Add a few things to the libvirt howto after my first pass running it:
- Add dependency installation
- Start libvirtd
- Show how to create the default libvirt storage pool
- Renumber sections after inserting new sections
- Fix rhcos image name
- Clarify that when running the --permanent commands for firewalld are
in addition to running the same commands without the flag
- change reference to ../libvirt.yaml to libvirt.yaml to match where
the file will be based on past instructions
This will make it easier to add special-case OWNERS files to
openshift/release while still getting the members slurped up with the
populate-owners tooling. That tooling pulls OWNERS_ALIASES since
openshift/release@e1f993fb (populate-owners: Also slurp
OWNERS_ALIASES, 2018-08-25, openshift/release#1285).
MAINTAINERS is obsolete since 49779c3e (OWNERS: Configure Prow with
approver and reviewer information, 2018-07-25, #71). I've also
dropped the email/IRC section, since as far as I know there are
currently no public lists or IRC channels for installer discussion.
Folks outside of Red Hat should communicate via GitHub issues and pull
requests, and I think that's the expectation for projects that don't
give alternatives in their CONTRIBUTING file.
Most of the folks I've listed here are under Aaron in Red Hat, with
Yifan being the installer lead. I've also included Alex and Clayton,
who are higher up in Red Hat but still members of
@openshift/installer. I'm guessing about roles, but we can always
adjust later as we see fit.
Approvers can also /lgtm [1], so there's no need to list them under
'reviewers' as well.
The docs link in OWNERS is from [2].
While updating CONTRIBUTING.md to mention OWNERS (using wording based
on [3]), I've also:
* Added a line to make it clear that filing issues is helpful to (for
folks who don't have the time or inclination to work up a PR).
* Turned the unordered list into an ordered list. These entries
happen sequentially, and an ordered list makes that more obvious.
* Made "below" a link, to make finding the referenced content more
convenient.
* Shuffled words in the commit message format title to make it
shorter.
The references to 'make structure-check' are stale since d61abd48 (*:
cleanup bazel rules, 2018-03-26, coreos/tectonic-installer#3137), but
I've left fixing that to follow-up work.
[1]: 4c0c2e9e65/contributors/guide/owners.md (quirks-of-the-process)
[2]: https://github.com/kubernetes/kubernetes-template-project/pull/15
[3]: 16f1588e6d/CONTRIBUTING.md (L10)
These used to be generated with terraform-docs, but the associated
Makefile rule was removed without replacement in d61abd48 (*: cleanup
bazel rules, 2018-03-26, coreos/tectonic-installer#3137).
terraform-examples seems to have been similar, and its last Makefile
reference was also removed in d61abd48. We may want to return to
autogenerating examples/*.yaml at some point, but for now, stop
claiming that we are autogenerating these.
GitHub uses Linuguist for syntax highlighting [1], and Linuguist
defines two related grammars:
* Shell (alias 'sh') [2], which applies to POSIX and similar shell
languages.
* ShellSession (alias 'console') [3], which extends the Shell grammar
with support for prompts and command output as you would usually see
in an interactive shell session.
This commit consistently uses 'sh' to highlight blocks which contain
only shell commands (without prompts or output). And it uses
'console' to highlight blocks which contain prompts, commands, and
output.
I've also removed prompts blocks which contain no output, because in
the no-output cases that approach seemed more popular within this
repository.
I've also standardised on the 'sh' alias, where this repository
previously used both 'sh' and 'shell'.
I've also added continuation prompts (PS2) to the long
describe-auto-scaling-groups example, to keep the continued command
from being marked up as output. And I've replaced the terminal \
continuation there with a terminal |; we need a pipe anyway so we
might as well save a character ;).
[1]: https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
[2]: https://github.com/github/linguist/blob/v6.2.0/lib/linguist/languages.yml#L4317-L4378
[3]: https://github.com/github/linguist/blob/v6.2.0/lib/linguist/languages.yml#L4379-L4390
As per https://github.com/coreos/docs/pull/1142, coreos golang code
style has been removed from cores/docs. This commit rewrites the
code style recommendation to link to the one maintained by
the go community.
From an idea in https://github.com/coreos/tectonic-installer/pull/1122#issuecomment-309531602,
as a new contributor I didn't know from reading the CONTRIBUTING
document that I was expected to run certain make commands. This
commit spells it out for contributors that come after me. As tests
are added this list should be expanded.
