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

DOC: adding template to show Zenko forums in pages #170

Merged
merged 1 commit into from
Jul 12, 2018
Merged

Conversation

smaffulli
Copy link
Contributor

@smaffulli smaffulli commented Jul 2, 2018

This template adds the possibility to discuss documentation on
Zenko forum. At the bottom of each docs page an iframe is loaded
showing a prompt to start a new thread in case there is not one
already. If there is already a thread open, the associated
discussion will be loaded.

You can see how this will look like on https://zenko.readthedocs.io/en/doc-discourse/root.html

@smaffulli smaffulli changed the title DOC: adding template to show Zenko forums in pages [DO NOT MERGE] DOC: adding template to show Zenko forums in pages Jul 3, 2018
@smaffulli smaffulli added help wanted doc Documentation labels Jul 3, 2018
@smaffulli
Copy link
Contributor Author

Ok, I enabled building this branch on RTD so we can test this more properly. The main thing to be decided is how to handle discussions pages on the forum: each URL will have one topic opened on forum.zenko.io, in the Docs category (currently visible only to admins). This means that each version of each page may have one topic assigned. For example, https://zenko.readthedocs.io/en/latest/root.hml and https://zenko.readthedocs.io/en/v1/root.hml both may have a discussion linked at the bottom (or a chance to create one). Is that what we want? The main drawback of this approach is that there may be many (many) new topics in the Docs category.

Also, if we publish documentation on multiple domains (i.e. https://zenko.readthedocs.io and https://zenko.io/docs) we'll multiply topics even more.

Thoughts?

@smaffulli smaffulli changed the title [DO NOT MERGE] DOC: adding template to show Zenko forums in pages DOC: adding template to show Zenko forums in pages Jul 9, 2018
@smaffulli
Copy link
Contributor Author

After thinking about it, I came to the conclusion that having one thread per page per version is not a bad thing after all. Can this be merged?

This template adds the possibility to discuss documentation on
Zenko forum. At the bottom of each docs page an iframe is loaded
showing a prompt to start a new thread in case there is not one
already. If there is already a thread open, the associated
discussion will be loaded.
@ssalaues ssalaues merged commit da54b57 into master Jul 12, 2018
@ssalaues ssalaues deleted the DOC/discourse branch July 12, 2018 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation help wanted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants