-
Notifications
You must be signed in to change notification settings - Fork 375
Add loose markdown linter #2796
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.
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
Draft
thibaultamartin
wants to merge
8
commits into
main
Choose a base branch
from
add-loose-markdown-linter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
e5ca466
Add a markdown linter in the CI
thibaultamartin 9fcd043
Add a loose configuration we will tighten over time
thibaultamartin a2de0bf
Use the proper file name for the markdown lint
thibaultamartin ec2ab41
Trigger the CI when necessary
thibaultamartin 197cf2c
Apply the linter autofix for bare urls
thibaultamartin 2a1beb3
Linter didn't detect pre as a code block
thibaultamartin 0c9b56e
Do not check alt text yet while we fix the backlog in a separate PR
thibaultamartin 28e9a1a
Explicitly add parameters we're interested in having eventually, but …
thibaultamartin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: Markdown lint | ||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
|
||
|
||
jobs: | ||
lint: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: DavidAnson/markdownlint-cli2-action@v20 | ||
with: | ||
globs: | | ||
content/**/*.md | ||
config: ".markdownlint.yaml" |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
default: false | ||
|
||
heading-increment: false | ||
heading-style: false | ||
ul-style: false | ||
list-indent: false | ||
ul-indent: false | ||
no-reversed-links: true | ||
no-missing-space-atx: false | ||
no-multiple-space-atx: false | ||
blanks-around-headings: false | ||
heading-start-left: false | ||
single-h1: false | ||
no-multiple-space-blockquote: false | ||
no-blanks-blockquote: false | ||
ol-prefix: false | ||
list-marker-space: false | ||
blanks-around-fences: false | ||
blanks-around-lists: false | ||
no-bare-urls: true | ||
hr-style: false | ||
no-space-in-emphasis: false | ||
no-space-in-code: false | ||
no-space-in-links: false | ||
no-empty-links: false | ||
no-alt-text: false | ||
code-block-style: false | ||
code-fence-style: false | ||
# emphasis-style: | ||
# style: underscore | ||
# strong-style: | ||
# style: consistent | ||
reference-links-images: false | ||
# table-pipe-style: | ||
# style: consistent | ||
table-column-coune: false | ||
blanks-around-tables: false | ||
|
||
fix: false | ||
gitignore: true |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -17,17 +17,17 @@ Great techie discussions and debates down there, the stand was flooded with inte | |
|
||
But he still found a few minutes to do a TV interview for SYSCon TV on Tuesday evening! :) | ||
|
||
[embed]http://youtu.be/JVq6S9V1Jcg[/embed] | ||
[embed]<http://youtu.be/JVq6S9V1Jcg[/embed>] | ||
|
||
## TAD Summit (Istanbul, November 12-13) | ||
|
||
Matrix was a partner at <a href="http://tadsummit.com/2014/">TAD Summit</a> in Istanbul this year, a great opportunity to meet a very good mix of developers, industry players and mobile networks! TAD mixes conferences and technical workshops where everyone gets involved to create a vibrant ecosystem for Telecom Application Developers. Again really productive discussions and meetings as we continue our search for partners to help support the uptake of Matrix. | ||
|
||
Matthew's talk was fully recorded so just watch the video to get the real pitch! | ||
|
||
[embed]http://youtu.be/ER3g4-4bFYk?list=PLO-gJ4-4x_IIYVTuLmVr8iUedvVdduYY4[/embed] | ||
[embed]<http://youtu.be/ER3g4-4bFYk?list=PLO-gJ4-4x_IIYVTuLmVr8iUedvVdduYY4[/embed>] | ||
|
||
[embed]https://www.youtube.com/watch?v=As-5vVdXhu0[/embed] | ||
[embed]<https://www.youtube.com/watch?v=As-5vVdXhu0[/embed>] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nope |
||
|
||
## WebRTC World (San Jose, November 18-20) | ||
|
||
|
@@ -46,4 +46,4 @@ And eventually, while Matthew and John were celebrating in San José (or flying | |
|
||
So if you speak French or are not afraid to only read from <a href="http://matrix.org/blog/wp-content/uploads/2014/11/2014-11-17.2-Matrix.pdf">the slides</a>, check out the video the team made of the pitch. The official one should be available soon! | ||
|
||
[embed]http://youtu.be/DyL9Ue0KlBU[/embed] | ||
[embed]<http://youtu.be/DyL9Ue0KlBU[/embed>] |
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -82,9 +82,11 @@ namespaces: | |
<strong>You will need to restart the home server after editing the config file before it will take effect.</strong> | ||
|
||
To test everything is working correctly, go ahead and explicitly create a room with the alias "#logged_test:localhost" and send a message into the room: the HS will relay the message to the AS by PUTing to /transactions/<tid> and you should see your AS print the event on the terminal. This will monitor any room which has an alias prefix of "#logged_", but it won't lazily create room aliases if they don't already exist. This means it will only log messages in the room you created before: #logged_test:localhost. Try joining the room "#logged_test2:localhost" without creating it, and it will fail. Let's fix that and add in lazy room creation: | ||
<pre>@app.route("/rooms/<alias>") | ||
|
||
``` | ||
@app.route("/rooms/<alias>") | ||
def query_alias(alias): | ||
alias_localpart = alias.split(":")[0][1:] | ||
alias_localpart = alias.split[":"](0)[1:] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nope |
||
requests.post( | ||
# NB: "TOKEN" is the as_token referred to in registration.yaml | ||
"<a href="http://localhost:8008/_matrix/client/api/v1/createRoom?access_token=TOKEN" target="_blank">http://localhost:8008/_matrix/client/api/v1/createRoom?access_token=TOKEN</a>", | ||
|
@@ -94,7 +96,8 @@ def query_alias(alias): | |
headers={'{'}"Content-Type":"application/json"{'}'} | ||
) | ||
return jsonify({'{'}{'}'}) | ||
</pre> | ||
```` | ||
|
||
This makes the application service lazily create a room with the requested alias whenever the HS queries the AS for the existence of that alias (when users try to join that room), allowing any room with the alias prefix #logged_ to be sent to the AS. Now try joining the room "#logged_test2:localhost" and it will work as you'd expect. You can see that if this were a real bridge, the AS would have checked for the existence of #logged_test2 in the remote network, and then lazily-created it in Matrix as required. | ||
|
||
Application services are powerful components which extend the functionality of home servers, but they are limited. They can only ever function in a "passive" way. For example, you cannot implement an application service which censors swear words in rooms, because there is no way to prevent the event from being sent. Aside from the fact that censoring will not work when using end-to-end encryption, all federated home servers would also need to reject the event in order to stop developing an inconsistent event graph. To "actively" monitor events, another component called a "Policy Server" is required, which is beyond the scope of this post. Also, Application Services can result in a performance bottleneck, as all events on the homeserver must be ordered and sent to the registered application services. If you are bridging huge amounts of traffic, you may be better off having your bridge directly talk the Server-Server federation API rather than the simpler Application Service API. | ||
|
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,7 +14,7 @@ Matrix will be represented at the 32nd Chaos Computer Club, Dec 27th-30th, 2015. | |
|
||
The session is free of charge, although you do need a ticket to the Congress itself. | ||
|
||
If you are interested, please register by sending an email to [email protected]. All you need for the session is curiosity - but do bring your own laptop if you want to hack as well! | ||
If you are interested, please register by sending an email to <[email protected]>. All you need for the session is curiosity - but do bring your own laptop if you want to hack as well! | ||
|
||
Anyone is welcome to join - it will basically be a fairly open-ended chat about all things relating to Matrix, and a good chance to do some deep digging into Matrix itself. | ||
|
||
|
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is a "coune"? is this going over my head or supposed to be "count"? is there a reference for all the options?