Update doc according npm workspace#636
Conversation
tharvik
left a comment
There was a problem hiding this comment.
superbe, thanks for the tiding up 🥇
comments are not blocking, rather "nice to have"
DEV.md
Outdated
| There are multiple ways to use and interact with DISCO, depending on your objective: | ||
|
|
||
| - A non-technical user that wants to train models in a distributed manner without coding would want to use DISCO through the `web-client`. To do so, starting a local `server` instance is also needed as a backend to the `web-client`. Similarly, a contributor aiming to implement new UI features would certainly want to run the same setup. | ||
| - A technical user may find it more flexible to use DISCO from a Node.js script, which gives users a finer control over the process. The `discojs-node` module is tailored to be used in Node.js scripts and allows to load data, start a server and run distributed machine learning training tasks. |
There was a problem hiding this comment.
starting a server is in the server package only, but indeed discojs-node can help build a server
| npm -w web-client start # from the root folder | ||
| npm start # from the web-client folder |
There was a problem hiding this comment.
hum, sometimes commands are from the root folder, sometimes from the local dir. we need to keep to only one style of command.
There was a problem hiding this comment.
In this case I'm giving two alternative ways of starting the web-client depending on the cwd. I'm trying to always use -w but I'm sometimes wary that some readers may have missed how -w worked
There was a problem hiding this comment.
do we add linting support here at all? if feel a bit out of scope. the current npm run lint doesn't work (but can made to work if merge the root eslintrc with the local one)
There was a problem hiding this comment.
I think that would be nice, how can I do it? I'm not what you mean by "merge tje root eslintrc"
There was a problem hiding this comment.
eslint uses a cascading config organisation, meaning that it aggregates all eslintrc files start from cwd and bubbling up the parent chain.
in the current case, it takes docs/examples/.eslintrc.json & .eslintrc.js, making the example non-local. you can copy the one from root in docs/examples and change its env to use node instead of mocha.
Co-authored-by: Valérian Rousset <tharvik@users.noreply.github.com>
Co-authored-by: Valérian Rousset <tharvik@users.noreply.github.com>
Co-authored-by: Valérian Rousset <tharvik@users.noreply.github.com>
Co-authored-by: Valérian Rousset <tharvik@users.noreply.github.com>
Co-authored-by: Valérian Rousset <tharvik@users.noreply.github.com>
Co-authored-by: Valérian Rousset <tharvik@users.noreply.github.com>
Update each module's instruction now that npm workspaces has been integrated
I reorganized the documentation with 3 different types of DISCO users in mind. What they should be able to do are concentric subsets:
As such, I organized the doc by following these successive levels:
Additionally:
docs/node_example, which I renameddocs/exampleswith the objective of adding further examples in the future.Out of scope: #639 Adding custom tasks is currently very convoluted and needs a rework to make it easier for external users. Information on how to add custom tasks is not clear and not accessible enough for any of the three user categories I mentioned.
I expect it got fixed by the previous PRs.