Continuing the discussion from A community effort to improve Discourse's documentation:
After a few occasional weekend sprints, I’m happy to share with you all what we’ve got so far:
Go have a look at learndiscourse.org, v1.0
Huge thanks goes out to @fantasticfears, @mcwumbly and @nahtnam for getting this off the ground together with me. We all owe a special thanks to @fantasticfears for doing most of the technical heavy lifting, which repeatedly gave the rest of us a much needed boost.
What is learndiscourse.org?
LearnDiscourse is just a Jekyll site, pulling all of its content from meta.discourse.org. It’s all of Meta’s How-to & FAQ articles, neatly categorised and collected into one clean overview.
The way it works is a mixture of automatic and manual labor. But the average doc contributor won’t ever have to leave Meta, or even learn any new conventions (though we might wanna try introduce some of those eventually).
To learn more about how it works, check out our WIP workflow doc.
We plan to keep iterating on this process, most likely introducing more advanced automation and build processes in the future.
What is the purpose of learndiscourse.org?
This site is our attempt at creating a proper documentation portal for the Discourse project. And since
- there’s already loads of top notch content hosted on Meta, and;
- Discourse has a top-of-the-line content editor…
…we concluded that the only major thing missing was a clear A-Z presentation layer. So that’s what the first iteration of learndiscourse.org is, and nothing more.
Going forward, I’m hoping Meta and LearnDiscourse can positively influence one another, and continue to be pulled ever closer together.
What does the “v1.0” mean?
This is merely the first iteration of the site. With more time and support, we’d like to keep on experimenting, as we have several ideas on how to make this site more useful. But before we get into that, this is what we’ll continue working on, content-wise, for v1.0:
The current lineup isn’t very impressive, but I will continue creating original articles for the Users category, with hopefully other contributors joining in over time.
UPDATE: Made some good progress!
Still very WIP. Hoping @mcwumbly can initiate some articles here once he’s got more time on his hands.
In good shape!
Also very sparse, and will probably stay that way until Discourse has more powerful theming capabilities built in.
- The Sub-categorisation (Install, Docker etc.) is pretty haphazardly done. Open to suggestions.
- Install is missing proper install guide, see separate discussion.
- Many docs might no longer be relevant and should be unlisted.
- Environment: We’d like to move some external blog posts and github guides into one place.
- Plugins: @Mittineague any plans to migrate your external tutorials to Meta?
- Discourse as your first Rails App should be on Meta.
- Would be nice to have @eviltrout’s embed article on Meta.
- Many docs in Hacking might no longer be relevant and should be unlisted.
- Order of sub-categories in sidebar doesn’t match order of corresponding subfolder.
- Sidebar should show all articles of current sub-category?
- No search yet.