Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

enable markdown linter in this repository #594

Merged
merged 55 commits into from
Jan 19, 2021
Merged

enable markdown linter in this repository #594

merged 55 commits into from
Jan 19, 2021

Conversation

dhellmann
Copy link
Contributor

Use github's super-linter, since that is easy to configure with a github
action. See .github/workflows/linter.yml for the job configuration.

Add a Makefile with a command to run the linter in a container locally.

Disable a few rules that seem pedantic and that we break a lot. See
.markdownlint.yaml for details.

Fix all of the other issues, using a separate commit for each directory
or top-level enhancement.

  • Wrap lines longer than 400 characters using emacs' fill-paragraph with
    fill-column set to 70.
  • Remove trailing whitespace.
  • Correct indentation for unordered lists.
  • Add language specifiers to fenced code blocks.
  • Remove trailing punctuation from headers.
  • Standardize on header format using prefix only.
  • Correct header increments (avoid an H3 followed by H5).
  • Clean up use of emphasis markup and whitespace.

@dhellmann
add Makefile with target to run markdown linter
8a4d45a 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in some "top level" files
3a7fd61 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/api-review
b74b033 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/art
677b081 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/authentication
32a74d8 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/autoscaling
bdda2a2 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/baremetal
1d6a2d1 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/cloud-integration
c552f33 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linting issues in cluster-high-availability-mode-api
53c6070 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/cluster-logging
b89c9b4 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/cluster-scope-secret-volumes
02b1fbc 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/console
4b6c9bb 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/dns
b3cf660 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/etcd
4c33b5b 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/fedramp
1044d59 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/helm3
2fc3672 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in host-network-configuration
6764fde 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/ingress
3b84be7 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/installer
0b64b10 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/kube-apiserver
cca6635 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/kubelet
57d7e50 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/local-storage
0f44741 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/machine-api
45594fa 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/machine-config
296602c 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in mcd-reboot-exceptions
df1e8a7 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/monitoring
9b84ba8 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/multi-arch
d4277ca 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/network
1379b5c 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/node-pull-credentials
6e6ac54 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/node-tuning
55ee5d9 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/security
52bf2d4 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/service-catalog
0b33a41 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in single-node-developer-cluster-profile
16ed4c1 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in single-node-production-deployment-approach
9cd8aee 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/storage
950dd71 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/subscription-content
e619796 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in support-for-realtime-kernel
0903dab 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/test-platform
c767358 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/testing
6e2c130 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/update
45c60b0 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/vertical-pod-autoscaler
64f867d 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in enhancements/windows-containers
a6ecddf 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in guidelines
a136a55 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in this-week
519167d 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
fix linter issues in tools
20b680c 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
add github action configuration
51a2030 
Signed-off-by: Doug Hellmann <dhellmann@redhat.com>
@dhellmann
Copy link
Contributor Author

/cc @russellb @wking @sferich888

Note the action won't run speculatively, but it will run on other PRs after we merge this one.

wking
wking reviewed Jan 19, 2021
View reviewed changes
enhancements/cloud-integration/aws/aws-sts-support.md

1. Create an IAM Role with no policy attached, type = web identity, identity provider created by the admin manually.
1. If the role will not be shared across multiple clusters and should be removed when the cluster is deprovisioned, tag it with `kubernetes.io/cluster/[infraid]=owned`.
1. Note that openshift-install destroy cluster will not cleanup the OIDC provider itself today.
1. Attach an in-line policy to the role which matches the permissions in the `CredentialsRequest` or documentation.
1. Ensure the trust relationship for the Role points to the cluster’s AWS IAM OIDC ARN with conditions to limit which `ServiceAccount` can assume this role.
```json

```json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this was probably intended to be indented to nest under the Ensure the trust relationship... point.

@wking
Copy link
Member

wking commented Jan 19, 2021

/lgtm

This is so big, and will be a pain to rebase. I'd rather land it quickly, even if we end up accidentally un-optimizing something like list nesting. We can always polish in follow-up PRs if it seems like it's worth it.

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 19, 2021
@russellb
Copy link
Member

/approve

@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: russellb

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 19, 2021
@openshift-merge-robot openshift-merge-robot merged commit feed05c into openshift:master Jan 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wking wking wking left review comments

@deads2k deads2k Awaiting requested review from deads2k

@stbenjam stbenjam Awaiting requested review from stbenjam

@russellb russellb Awaiting requested review from russellb

@sferich888 sferich888 Awaiting requested review from sferich888

Assignees

@wking wking

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@dhellmann @wking @russellb @openshift-ci-robot @openshift-merge-robot