Skip to content

Commit

Permalink
Wider markdownlint settings (#4113)
Browse files Browse the repository at this point in the history
  • Loading branch information
fiskus committed Aug 21, 2024
1 parent 2aa44b9 commit 52edfdb
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 15 deletions.
5 changes: 1 addition & 4 deletions .github/workflows/js-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,11 @@ jobs:
name: ${{ github.job }}
lint-docs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: docs
env:
NODE_OPTIONS: --max-old-space-size=4096
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: 'catalog/package.json'
- run: npx --package=markdownlint-cli markdownlint --ignore node_modules **/*.md
- run: npx --package=markdownlint-cli markdownlint .
12 changes: 12 additions & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Not ready for lint yet
gendocs
lambdas
py-shared
testdocs

# Autogenerated
docs/api-reference

.git
catalog/node_modules
venv
8 changes: 6 additions & 2 deletions catalog/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,9 @@ where verb is one of

## Changes

- [Added] Support `ui.actions.downloadObject` and `ui.actions.downloadPackage` options for configuring visibility of download buttons under "Bucket" and "Packages" respectively ([#4111](https://github.com/quiltdata/quilt/pull/4111))
- [Added] Bootstrap the change log ([#4112](https://github.com/quiltdata/quilt/pull/4112))
- [Added] Support `ui.actions.downloadObject` and `ui.actions.downloadPackage`
options for configuring visibility of download buttons under "Bucket"
and "Packages" respectively
([#4111](https://github.com/quiltdata/quilt/pull/4111))
- [Added] Bootstrap the change log
([#4112](https://github.com/quiltdata/quilt/pull/4112))
8 changes: 4 additions & 4 deletions catalog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

The catalog is a web frontend for browsing meta-data held by the Quilt registry.

# Developer

## Configuration

The app configuration (API endpoints, bucket federations, etc.) is read from
Expand Down Expand Up @@ -41,8 +39,10 @@ $ npm start

### Fetch

- An accurate check for a successful fetch() would include checking that the promise resolved, then checking that the Response.ok property has a value of true. The code would look something like this:
[msdn fetch doc](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch)
- An accurate check for a successful fetch() would include checking that
the promise resolved, then checking that the Response.ok property has
a value of true. The code would look something like this:
[msdn fetch doc](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch)

## Deployment (for Quilt internal usage)

Expand Down
10 changes: 5 additions & 5 deletions docs/CHUNKED_CHECKSUMS.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,16 @@ The key differences are:

It can reuse hashes generated by
[create_multipart_upload](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/create_multipart_upload.html)
as of at least [boto3 1.34.44](https://pypi.org/project/boto3/1.34.44/)
as of at least [boto3 1.34.44](https://pypi.org/project/boto3/1.34.44/)
(2024-02-16), simply by rehashing the value if source_size < 8 MiB.

<!-- markdownlint-disable line-length -->
## Multiformats Registration

* Name: sha2-256-chunked
* Prefix: 0xb510
* Status: draft
* Type: multihash
* Description: Hash of concatenated SHA2-256 digests of 8*2^n MiB source chunks;
n = ceil(log2(source_size/(10^4 * 8MiB)))
* Registrar: [multiformats/multicodec](https://github.com/multiformats/multicodec)
* Registration Date: [2024-02-23](https://github.com/multiformats/multicodec/pull/343)
* Description: Hash of concatenated SHA2-256 digests of 8*2^n MiB source chunks; n = ceil(log2(source_size/(10^4*8MiB)))
* Registrar: [multiformats/multicodec](https://github.com/multiformats/multicodec)
* Registration Date: [2024-02-23](https://github.com/multiformats/multicodec/pull/343)
1 change: 1 addition & 0 deletions docs/advanced-features/sso-permissions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable no-blanks-blockquote -->
# SSO permissions mapping

> This feature requires Quilt stack version 1.54.0 or higher
Expand Down

0 comments on commit 52edfdb

Please sign in to comment.