Monorepo for documentation site #7
Conversation
README.md
Outdated
| xdg-open index.html | ||
| ``` | ||
|
|
||
| ### Manually |
There was a problem hiding this comment.
Hello, I'm proposing some improvements to the Manually installation section:
I had more an approach of avoiding implicit installation, and showing an installation process where only copy/paste could be done to have something working.
Example here is mainly about node. I'm thinking it's better to display a way to install node to avoid extra search for installation. User who know how node work will skip this step or use a package manager or expected configs.
Check out the given README.md : https://github.com/AbcSxyZ/docs-base/blob/readme/README.md
You could just replace the ### Manually section of the README if you think change are interesting.
There was a problem hiding this comment.
That seems better, I'll copy it
I'll add also the node installation, but using nvm, as that's better for working with multiple versions of node (it's similar to rbenv on ruby)
There was a problem hiding this comment.
It's better to manage ruby versionning, but I would avoid it because it's adding complexity. I think developer should learn about managing software version in other places. Someone who know node will be already carrying about it, but it can be confusing for non node dev.
There was a problem hiding this comment.
EDIT:
I'm wrong it look's good, nvm is not adding complexity to the installation
README.md
Outdated
|
|
||
| ## Install locally | ||
|
|
||
| ### Docker |
There was a problem hiding this comment.
Also, I think manual installation should go first, and using specific tech later.
There was a problem hiding this comment.
Ok, that makes sense... I'm just trying to push "docker as the first option" on Decidim because is more consistent and cleaner, but maybe the world is not ready yet 🤔
There was a problem hiding this comment.
Totally agree, it's making installation easier. People who know docker will check it first, but a person who don't know docker will have to learn/install it first before running any docker command. I don't know what do you expect with "docker as the first option", but just making a docker command available will already increase docker usage
Making the user just copy/paste to get something working seems more interesting, it will be shorter to getting started
|
I've just implemented also #6 and also #2 with the repository https://github.com/decidim/documentation-antora-ui/ I'm going to merge to keep working on other PR with the rest of the issues Thanks @AbcSxyZ for your feedback! Until we have closed #1 this will be available on http://decidim-documentation.netlify.app/ - after it will be https://docs.decidim.org |
andreslucena
changed the title
Antora is a multi-repository generator for documentation. This is a little overkill for Decidim at the moment.
This is a WIP at the moment. This adds:
Still, there are lots of things missing but is a starter