-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Update FairOS documentation that can be found at https://docs.fairos.fairdatasociety.org/docs/, to be ready before 2022 Winter Solstice event and inline with all the new changes done in connection with FDP.
At one stage, a more thorough review is needed, but going through documentation in a semi-rapid pace, at least the following needs to be done (but more can also be done):
Welcome page: https://docs.fairos.fairdatasociety.org/docs/
- update info bubble (probably old?)
- change references to Fairdrive protocol to be about Fair Data Protocol (as it was renamed some time ago; also CTRL-F through other pages for any references)
- check for broken links (e.g. tutorial section does not exist)
- check the section menu on the right side of page as it includes some strange text "alt text"
- it should be mentioned, that this site is about the Go FairOS implementation, while a JS one also exists (fdp-storage)
- maybe mention that the Go version can be integrated to other languages via some method (WASM?), so the ecosystem is larger then just Go or JS
Introduction : https://docs.fairos.fairdatasociety.org/docs/fairOS-dfs/introduction
- diagram : Fairdrive connect is now fairos-connect; also maybe some pieces from FDP could be added to diagram where it makes sense?
- User section: can be updated as we have new kinds of accounts, based on FDP FIP?
- Pod / Logical Drive section: can be updated with info from the FDP FIP?
Portable account : https://docs.fairos.fairdatasociety.org/docs/fairOS-dfs/portable-account
- needs content; also link to this section from the Intro page, where we talk about Users
API reference : https://docs.fairos.fairdatasociety.org/docs/fairOS-dfs/api-reference
- remove the commands from this page, as the are in the linked page with the API reference? do not duplicate work for updating. keep maybe just a simple example, so it is clear how to use the API.
REPL client: https://docs.fairos.fairdatasociety.org/docs/fairOS-dfs/cli-reference
- check if everything up-to-date
- could this documentation be generated from code somehow? not to have two places to maintain it (as it is already in the "dfs-cli help" ?) or just keep an example here and how to get to it
Developer info : https://docs.fairos.fairdatasociety.org/docs/fairOS-dfs/developer-info
- the link to the API gateway points to an old gateway? (or maybe just last major release);
- also post here or link to somewhere where there is info about versions of FairOS - e.g. the linked gateway runs FairOS 0.7.3-dev; what can a dev expect from that version as compared to latest one
Footer of page
check links, a lot of them do not work
- FairOS-dfs should link back to the https://docs.fairos.fairdatasociety.org
- Twitter should point to https://twitter.com/FairDataSociety
- Blog should point to: https://blog.fairdatasociety.org/
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation