Add HtmlProofer to validate links as well as fix current issues #1851
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I didn't realize but this might be similar to #1848 |
stevesloka
force-pushed
the
addHtmlProofer
branch
from
faf1f50
to
1056d4a
Compare
jpeach
approved these changes
Nov 4, 2019
Makefile
Outdated
| @@ -39,7 +39,7 @@ vet: | test | |||
| go vet $(MODULE)/... | |||
|
|
|||
| check: ## Run tests and CI checks | |||
| check: test test-race vet gofmt staticcheck misspell unconvert unparam ineffassign yamllint check-stale | |||
| check: test test-race vet gofmt staticcheck misspell unconvert unparam ineffassign yamllint check-stale site-check | |||
There was a problem hiding this comment.
My workflow is normally make check, but the Docker install takes a long time. I can switch to make test but not sure whether we want check to take longer by default.
There was a problem hiding this comment.
make check is what we run for each PR on Travis. Obviously, we can change that and run multiple things but my initial thought was to run this on each check. For now, I'm going to take out because there are other issues involved with this to run via CI.
Makefile
Outdated
| @@ -218,6 +218,10 @@ site-devel: ## Launch the website in a Docker container | |||
| docker run --publish $(JEKYLL_PORT):$(JEKYLL_PORT) -v $$(pwd)/site:/site -it $(JEKYLL_IMAGE) \ | |||
| bash -c "cd /site && bundle install && bundle exec jekyll serve --host 0.0.0.0 --port $(JEKYLL_PORT) --livereload" | |||
|
|
|||
| site-check: ## Launch the website in a Docker container | |||
There was a problem hiding this comment.
Can you please update the doc comment?
site/_config.yml
Outdated
| @@ -28,7 +28,7 @@ footer_social_links: | |||
| url: https://kubernetes.slack.com/messages/contour | |||
| RSS: | |||
| fa_icon: fa fa-rss | |||
| url: feed.xml | |||
| url: http://projectcontour.io/feed.xml | |||
site/_config.yml
Outdated
| @@ -46,6 +46,7 @@ defaults: | |||
| layout: "default" | |||
|
|
|||
| repository: projectcontour/contour | |||
| github: [metadata] | |||
There was a problem hiding this comment.
Removes the errors when not providing GH creds. It was failing the Travis build.
| @@ -36,7 +36,7 @@ Until Contour release v0.14, the deployment model placed Contour and Envoy in th | |||
| The split model allows Contour and Envoy to scale independently. If a new version of Contour is released, you can now upgrade to the new version without having to restart each instance of Envoy in your cluster. | |||
|
|
|||
| A key new feature in Contour v0.14 is that we have secured the communication between Contour and Envoy over the xDS API connection utilizing mutually checked self-signed certificates. There are three ways to generate certificates to secure this connection. | |||
| The Contour repo includes step-by-step examples of how to generate certificates from a command line if you want to [generate them by hand](https://github.com/projectcontour/contour/blob/master/docs/grpc-tls-howto.md#generating-example-grpc-tls-certificates); the example/ds-hostnet-split [example](https://github.com/projectcontour/contour/tree/master/examples/ds-hostnet-split) includes a [job](https://github.com/projectcontour/contour/blob/master/examples/ds-hostnet-split/02-job-certgen.yaml) which automatically generate the certificates, or you could provide your own based on your IT security requirements. | |||
| The Contour repo includes step-by-step examples of how to generate certificates from a command line if you want to [generate them by hand](https://projectcontour.io/guides/grpc-tls-howto#generating-example-grpc-tls-certificates); the example/contour [example](https://github.com/projectcontour/contour/blob/master/examples/contour) includes a [job](https://github.com/projectcontour/contour/blob/master/examples/contour/02-job-certgen.yaml) which automatically generate the certificates, or you could provide your own based on your IT security requirements. | |||
There was a problem hiding this comment.
Can you use site.github.repository_url for these links?
| @@ -23,7 +23,7 @@ This page describes the compatibility matrix of Contour and Envoy versions. | |||
| ## Envoy extensions | |||
|
|
|||
| Contour requires the following extensions. | |||
| If you are using the image recommended in our [example deployment](https://github.com/projectcontour/contour/blog/{{ site.github.latest_release.tag_name }}/examples/contour) no action is required. | |||
| If you are using the image recommended in our [example deployment](https://github.com/projectcontour/contour/tree/{{ site.github.latest_release.tag_name }}/examples/contour) no action is required. | |||
There was a problem hiding this comment.
Can you use site.github.repository_url here?
|
|
||
| # TLS support | ||
|
|
||
| Contour 0.3 adds support for HTTPS (TLS/SSL) ingress by integrating Envoy's SNI support. |
There was a problem hiding this comment.
Isn't 0.3 ancient history? How about we just say that Contour supports TLS for Ingress and HTTPProxy?
There was a problem hiding this comment.
Sure, this PR wasn't looking to update previous docs, but I can do that here.
stevesloka
force-pushed
the
addHtmlProofer
branch
from
32033e3
to
b979bee
Compare
…site Signed-off-by: Steve Sloka <slokas@vmware.com>
stevesloka
force-pushed
the
addHtmlProofer
branch
from
b979bee
to
9acd69b
Compare
Merged
|
Over all it LGTM. |
SDBrett
added a commit
to SDBrett/contour
that referenced
this pull request
Nov 6, 2019
Adjustments to colour themes to improve contrast rations Addition of titles to iframes for resources page Updated buttons to improve contrast on highlight Addition of link titles Note: Image alt tags where not adjusted as they have been referenced in PR projectcontour#1851 Reference: Google lighthouse fundamentals: https://developers.google.com/web/fundamentals/accessibility?utm_source=lighthouse&utm_medium=devtools Site accessibility rules: https://dequeuniversity.com/rules/axe/3.4 Signed-off-by: Brett Johnson <brett@sdbrett.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Steve Sloka slokas@vmware.com