Skip to content

Commit

Permalink
docs: fix typo in API access rules and improve layout (#599)
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Fenech <[email protected]>
  • Loading branch information
fenech authored Dec 5, 2020
1 parent 9d1dbde commit 6a30ce2
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
7 changes: 5 additions & 2 deletions docs/docs/api-access-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ Access Rules have four principal keys:
matching strategy (glob or regexp) is defined in the global configuration
file as `access_rules.matching_strategy`. This matcher ignores query
parameters. Regular expressions (or glob patterns) are encapsulated in
brackets `<` and `>`. Regular expressions examples:
brackets `<` and `>`.

Regular expressions examples:
- `https://mydomain.com/` matches `https://mydomain.com/` and does not match
`https://mydomain.com/foo` or `https://mydomain.com`.
- `<https|http>://mydomain.com/<.*>` matches:`https://mydomain.com/` or
Expand All @@ -108,7 +110,8 @@ Access Rules have four principal keys:
- `http://mydomain.com/<(?!protected).*>` matches
`http://mydomain.com/resource` and does not match
`http://mydomain.com/protected`
[Glop](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)

[Glob](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)
patterns examples:
- `https://mydomain.com/<m?n>` matches `https://mydomain.com/man` and does
not match `http://mydomain.com/foo`.
Expand Down
7 changes: 5 additions & 2 deletions docs/versioned_docs/version-v0.37/api-access-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ Access Rules have four principal keys:
matching strategy (glob or regexp) is defined in the global configuration
file as `access_rules.matching_strategy`. This matcher ignores query
parameters. Regular expressions (or glob patterns) are encapsulated in
brackets `<` and `>`. Regular expressions examples:
brackets `<` and `>`.

Regular expressions examples:
- `https://mydomain.com/` matches `https://mydomain.com/` and does not match
`https://mydomain.com/foo` or `https://mydomain.com`.
- `<https|http>://mydomain.com/<.*>` matches:`https://mydomain.com/` or
Expand All @@ -99,7 +101,8 @@ Access Rules have four principal keys:
- `http://mydomain.com/<(?!protected).*>` matches
`http://mydomain.com/resource` and does not match
`http://mydomain.com/protected`
[Glop](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)

[Glob](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)
patterns examples:
- `https://mydomain.com/<m?n>` matches `https://mydomain.com/man` and does
not match `http://mydomain.com/foo`.
Expand Down
7 changes: 5 additions & 2 deletions docs/versioned_docs/version-v0.38/api-access-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ Access Rules have four principal keys:
matching strategy (glob or regexp) is defined in the global configuration
file as `access_rules.matching_strategy`. This matcher ignores query
parameters. Regular expressions (or glob patterns) are encapsulated in
brackets `<` and `>`. Regular expressions examples:
brackets `<` and `>`.

Regular expressions examples:
- `https://mydomain.com/` matches `https://mydomain.com/` and does not match
`https://mydomain.com/foo` or `https://mydomain.com`.
- `<https|http>://mydomain.com/<.*>` matches:`https://mydomain.com/` or
Expand All @@ -99,7 +101,8 @@ Access Rules have four principal keys:
- `http://mydomain.com/<(?!protected).*>` matches
`http://mydomain.com/resource` and does not match
`http://mydomain.com/protected`
[Glop](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)

[Glob](http://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm)
patterns examples:
- `https://mydomain.com/<m?n>` matches `https://mydomain.com/man` and does
not match `http://mydomain.com/foo`.
Expand Down

0 comments on commit 6a30ce2

Please sign in to comment.