fix links #416
fix links #416
Conversation
|
Looks like the GH Action is not automatically run. Not sure if some setting in this repo needs to be enabled for this to work. |
dholbach
changed the title
|
@dholbach I am not an expert on the usage of GitHub actions either. I am pretty strong with Prow. Github actions seem like a fine solution. Repo location for code inspection: https://github.com/gaurav-nelson/github-action-markdown-link-check I will take a look at the v1 release and determine if it is suitable from a security perspective. I suspect Github actions may have some security implications for the CNCF's git organization. The security sig may also wish to take a look. CHeers |
|
For other reviewers, this is how the github actions appear. @dholbach Do github actions leave a comment in the review indicating the workflow status, or work as a full integration like prow with voting/nonvoting checks? Cheers |
|
I'm happy to just fix the links in this PR, so we can get it merged and have a separate PR for link checking. It turned out
They turn up e.g. in the "checks" section of PRs: see https://github.com/fluxcd/flux/pull/3035/checks (relevant workflows are here) for example. |
Signed-off-by: Daniel Holbach <[email protected]>
|
@dholbach I noticed many of the links are broken as well. I am happy to join forces with you on fixing the links - it's my least favorite thing to do, but it needs to be done to maintain a proper operating repository. Something I fixed this morning which brought attention to the github actions linting was: #443. If you wish the assistance, ping me on slack (@sdake in most Slacks). Once we get the repo in good shape, we may be able to turn on some basic linting. Cheers |
Signed-off-by: Daniel Holbach <[email protected]>
|
This PR should be good to go - it will just fix a couple of links. As noted in #444 there is still more to do. |
| @@ -20,7 +20,7 @@ Possible ways to contribute: | |||
|
|
|||
| If you are interested in engaging in this way, we would encourage you to issue a pull request to [TOC Contributors](https://github.com/cncf/toc/blob/master/CONTRIBUTORS.md) that you desire to become a TOC Contributor. Although there is not an actual limit of having one Contributor per company, we would encourage CNCF member companies to designate an official TOC Contributor who is tasked with consulting internal experts and expressing a semi-official view on a given project. We will list current TOC Contributors on a page similar to https://www.cncf.io/people/ambassadors/. | |||
|
|
|||
| This is not only about individual contribution. It is also about rallying help from your employer, e.g., if you work for a CNCF Member company. Given the [breadth](https://raw.githubusercontent.com/cncf/landscape/master/landscape/CloudNativeLandscape_v0.9.5_cncf.jpg) of projects represented by cloud native, it is impossible for anyone to be an expert in all technologies that we’re evaluating. We’re particularly interested in Contributors that can act as a focal point for tapping relevant expertise from their organizations and colleagues in order to engage with CNCF discussions in a timely manner. | |||
| This is not only about individual contribution. It is also about rallying help from your employer, e.g., if you work for a CNCF Member company. Given the [breadth](https://landscape.cncf.io/) of projects represented by cloud native, it is impossible for anyone to be an expert in all technologies that we’re evaluating. We’re particularly interested in Contributors that can act as a focal point for tapping relevant expertise from their organizations and colleagues in order to engage with CNCF discussions in a timely manner. | |||
| @@ -151,13 +151,13 @@ In the [GitHub project](https://github.com/weaveworks/flux). | |||
| ## Website | |||
|
|
|||
| None at present; documentation is in markdown format in the [GitHub | |||
| repo](https://github.com/weaveworks/flux/tree/master/site). | |||
| repo](https://github.com/weaveworks/flux/tree/master/docs). | |||
There was a problem hiding this comment.
why not (https://github.com/fluxcd/flux/blob/master/docs/index.md/)
There was a problem hiding this comment.
Because the link points to where the documentation lives, e.g. which sub-directory.
It moved to from ./site to ./docs and is now available on docs.fluxcd.io.
There was a problem hiding this comment.
I understand. I just thought we would save the redirect that happens;
sdake@beast-01:~$ curl https://github.com/weaveworks/flux/tree/master/docs/
<html><body>You are being <a href="https://github.com/fluxcd/flux/tree/master/docs">redirected</a>.</body></html>
As this hits github multiple times.
|
|
||
| ## Release methodology and mechanics | ||
|
|
||
| Container images and executables for releases are built in CI. The | ||
| process of preparing a release is [explained | ||
| here](https://github.com/weaveworks/flux/blob/master/internal_docs/releasing.md). | ||
| here](https://github.com/weaveworks/flux/blob/master/internal/docs/releasing.md). |
| @@ -55,7 +55,7 @@ _Principle: Great projects already have many ingredients to succeed. First: do n | |||
| Identify projects that have a real shot at being a useful tool in the evolving box of cloud native technology. This is a mix of mature and early-stage projects. Early stage may not have all the criteria we want: diverse contributor bases, formalized governance, interoperability, cloud-native designs, quality bar, etc. | |||
|
|
|||
| Some considerations: | |||
| - Transparent, consistent technical and governance quality bar for [graduation](https://www.cncf.io/projects/graduation-criteria/) from incubation | |||
| - Transparent, consistent technical and governance quality bar for [graduation](/process/graduation_criteria.adoc) from incubation | |||
There was a problem hiding this comment.
This LGTM. I am not a web indvidiual - I program infratructure. When working with documentation I have been told to always use a trialing slash is it prevents a dual hit to a website. A quick google search turns up this recommendation:
https://www.cloudways.com/blog/trailing-slashes-urls/
Essentially use a trailing slash on directories, or not if it is definitely a file.
This change LGTM.
Fix a number of broken links.