mirror of https://github.com/knative/docs.git
Add link styling rules (#4155)
* Add link styling rules * Update docs/help/contributor/style-guide/style-and-formatting.md Co-authored-by: Samia Nneji <snneji@vmware.com> * Moved rule further up Co-authored-by: Samia Nneji <snneji@vmware.com>
This commit is contained in:
parent
6f7060b74f
commit
0fbf050d5d
|
@ -30,13 +30,36 @@
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
### Make links descriptive
|
### Describe what the link targets
|
||||||
|
|
||||||
|:white_check_mark: Correct |:no_entry: Incorrect
|
|:white_check_mark: Correct |:no_entry: Incorrect
|
||||||
|---------------------------------------|------
|
|---------------------------------------|------
|
||||||
|For an explanation of what makes a good hyperlink, see this [this article](https://medium.com/@heyoka/Correctnt-use-click-here-f32f445d1021).| See this article [here](https://medium.com/@heyoka/Correctnt-use-click-here-f32f445d1021).
|
|For an explanation of what makes a good hyperlink, see this [this article](https://medium.com/@heyoka/Correctnt-use-click-here-f32f445d1021).| See this article [here](https://medium.com/@heyoka/Correctnt-use-click-here-f32f445d1021).
|
||||||
|
|
||||||
<!-- Add rule here, see https://github.com/knative/docs/issues/4034 -->
|
### Write links in Markdown, not HTML
|
||||||
|
|
||||||
|
|:white_check_mark: Correct |:no_entry: Incorrect|
|
||||||
|
|---------------------------------------|------|
|
||||||
|
|`[Kafka Broker](../kafka-broker/README.md)`|`<a href="../kafka-broker/README.md">Kafka Broker</a>`|
|
||||||
|
|`[Kafka Broker](../kafka-broker/README.md){target=_blank}`|`<a href="../kafka-broker/README.md" target="_blank">Kafka Broker</a>`|
|
||||||
|
|
||||||
|
### Include the .md extension in internal links
|
||||||
|
|
||||||
|
|:white_check_mark: Correct |:no_entry: Incorrect|
|
||||||
|
|---------------------------------------|------|
|
||||||
|
|`[Setting up a custom domain](../serving/using-a-custom-domain.md)`|`[Setting up a custom domain](../serving/using-a-custom-domain)`|
|
||||||
|
|
||||||
|
### Link to files, not folders
|
||||||
|
|
||||||
|
|:white_check_mark: Correct |:no_entry: Incorrect|
|
||||||
|
|---------------------------------------|------|
|
||||||
|
|`[Kafka Broker](../kafka-broker/README.md)`|`[Kafka Broker](../kafka-broker/)`|
|
||||||
|
|
||||||
|
### Ensure the letter case is correct
|
||||||
|
|
||||||
|
|:white_check_mark: Correct |:no_entry: Incorrect|
|
||||||
|
|---------------------------------------|------|
|
||||||
|
|`[Kafka Broker](../kafka-broker/README.md)`|`[Kafka Broker](../kafka-broker/readme.md)`|
|
||||||
|
|
||||||
## Formatting
|
## Formatting
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue