Skip to content
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

Enable additional sources #6

Merged
merged 27 commits into from
Jun 13, 2024
Merged

Enable additional sources #6

merged 27 commits into from
Jun 13, 2024

Conversation

Ndpnt
Copy link
Member

@Ndpnt Ndpnt commented Jun 10, 2024

First part of the review in #4

@Ndpnt Ndpnt requested a review from MattiSG June 10, 2024 16:06
Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only blocking point is the changelog, as it does not abide by our rules and has a wrong reference.

There is room for improvement in code quality for the tests and the parsing algorithm, which mixes promise style and imperative style and is more complex than necessary. It would benefit from some refactoring. This is acceptable as is if we're short on time.

Overall, this change is an interesting case where, if we knew of deployed instances, it would be easy and relevant to have backward compatibility.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
src/services/collections.js Outdated Show resolved Hide resolved
src/services/collections.js Outdated Show resolved Hide resolved
src/services/collections.test.js Show resolved Hide resolved
test/helper.js Show resolved Hide resolved
test/helper.js Outdated Show resolved Hide resolved
test/helper.js Outdated Show resolved Hide resolved
src/index.js Outdated Show resolved Hide resolved
@MattiSG
Copy link
Member

MattiSG commented Jun 12, 2024

See also #4 (review)

Ndpnt and others added 2 commits June 12, 2024 11:08
Co-authored-by: Matti Schneider <gh@mattischneider.fr>
Co-authored-by: Matti Schneider <gh@mattischneider.fr>
@Ndpnt Ndpnt requested a review from MattiSG June 13, 2024 08:19
Copy link
Member

@MattiSG MattiSG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good comment in the helper file!

CHANGELOG.md Outdated Show resolved Hide resolved

### Changed

- **Breaking:** Support arbitrary collections as sources; rename `collectionsUrl` config entry into `collections` and wrap it in an array, refer to the [documentation](https://docs.opentermsarchive.org/api/federated/#configuring) for details
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if it would not be safer to use a permalink (i.e. to the commit in the doc) rather than a doc URL that will not be valid in a few months.

src/utils/url.js Outdated Show resolved Hide resolved
src/services/collections.js Outdated Show resolved Hide resolved
@Ndpnt Ndpnt merged commit e42f183 into main Jun 13, 2024
4 checks passed
@Ndpnt Ndpnt deleted the enable-additional-sources branch June 13, 2024 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants