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

Sort out docs hosting strategy #27

Open
olivierdalang opened this issue Jun 8, 2020 · 3 comments
Open

Sort out docs hosting strategy #27

olivierdalang opened this issue Jun 8, 2020 · 3 comments

Comments

@olivierdalang
Copy link
Collaborator

Currently, docs isn't server from github pages anymore, meaning changes to /docs won't be reflected automatically.

We need to see how we want to deal with this (with Tomas).

@olivierdalang
Copy link
Collaborator Author

@chris-traveltime @Chris-Hutch-iGeo (sorry not sure which username it is :-) ) any news on this ?

I just looked at the help from within the plugin, and now it just renders the website, with menu and everything. But as it's just in a small window so it's not really navigable... If we want to keep it like this, I suggest to remove the in-qgis help altogether and just open the browser instead.

Also this doesn't address the issue of sync between docs and new releases, but I think this can wait for a next major update where update to docs is actually required.

@chris-traveltime
Copy link

@olivierdalang I think your suggestion to remove the in-qgis help and simply open in the browser makes the most sense. Agreed it's quite hard to navigate now that the help has changed slightly.

We haven't had a chance to discuss the docs sync yet, but yes let's wait for the next major update.

@olivierdalang
Copy link
Collaborator Author

@nick-traveltime Just a ping on this issue as well, as the one about throttling will require a docs update. Not sure how the pipeline to publish docs work currently, ideally we'd have something setup to publish help directly from this repo, so new features can just contain docs updates as well.

@olivierdalang olivierdalang added this to the some day milestone Mar 28, 2022
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

No branches or pull requests

2 participants