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

Expose tags_separator config through /info API #1997

Merged
merged 1 commit into from Jun 30, 2023
Merged

Expose tags_separator config through /info API #1997

merged 1 commit into from Jun 30, 2023

Conversation

amadeous
Copy link

Expose the value of the configured tags_separator through the /info API endpoint.
This value can be used by clients (such as Shaarlier, see issue #55 on Shaarlier) for consistency.

Copy link
Member

@nodiscc nodiscc left a comment

Choose a reason for hiding this comment

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

@amadeous
Copy link
Author

You're right. I forgot that doc. I did the PR 38 (here) on the api-documentation repo.

Is there any reason why the api documentation is separated from the main documentation?
It would be appreciable to have both at the same location (and also to stop using aglio.js, as the last commit was in 2018.. ^^")

@nodiscc
Copy link
Member

nodiscc commented Jun 28, 2023

Is there any reason why the api documentation is separated from the main documentation? It would be appreciable to have both at the same location

I'd also prefer it to be moved to the main repo. There is no actual reason other than (I guess) being able to use the https://shaarli.github.io/api-documentation/ URL on Github pages. I think that could be worked around easily (keep https://github.com/shaarli/api-documentation an empty repository, and have Shaarli's main repository CI push to the gh-pages branch there). Or maybe just regroup it with https://shaarli.readthedocs.io/?

and also to stop using aglio.js, as the last commit was in 2018

Actually the API documentation repo has been neglected since 2020, it still uses our old Travis CI account which stopped working about a year ago. I'm not sure the documentation itself is up to date, your PR to expose tags_separator just reminded me that this repo existed. As you noticed, the documentation renderer (aglio) is also unmaintained. We should move to another generator that supports the API blueprint source format.

Thank you for pointing this out, I'll open separate issues and see what can be done.

@nodiscc
Copy link
Member

nodiscc commented Jun 30, 2023

Thank you for pointing this out, I'll open separate issues and see what can be done.

#1999

@nodiscc nodiscc merged commit c44a0d2 into shaarli:master Jun 30, 2023
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants