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.

Sign up for GitHub

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

Jump to bottom

docs(api-server): finish writing the readme file #341

Closed
petermetz opened this issue Nov 3, 2020 · 0 comments · Fixed by #722
Closed

docs(api-server): finish writing the readme file #341

petermetz opened this issue Nov 3, 2020 · 0 comments · Fixed by #722
Assignees
@petermetz
Labels
API_Server Developer_Experience documentation Improvements or additions to documentation good-first-issue Good for newcomers Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label.
Milestone
v1.0.0

Comments

@petermetz
Copy link
Contributor

petermetz commented Nov 3, 2020 •
edited
Loading

Description

As a person browsing Cactus packages on a public node package registry (such as https://www.npmjs.com/) I want to have a README.md file presented to me that is not just a placeholder so that I can obtain the information I need/want to as fast as possible.

It is acceptable to have the README.md file point to existing documentation elsewhere in the project folder structure if that avoid duplication. The point is that whoever sees the package's README should be provided with at least a link to somewhere else where they can read the documentation.

Acceptance Criteria

  1. Legible code-level usage example of the API server demonstrating how to start the API server with plugins added through a registry

cc: @jonathan-m-hamilton @takeutak @sfuji822
@petermetz petermetz added documentation Improvements or additions to documentation good-first-issue Good for newcomers API_Server Developer_Experience Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label. labels Nov 3, 2020
@petermetz petermetz added this to the v1.0.0 milestone Nov 3, 2020
petermetz added a commit to petermetz/cacti that referenced this issue Mar 25, 2021
@petermetz
docs(cmd-api-server): finish writing the readme file hyperledger-cact…
c51c722 
…i#341

Added a README file for the API server equipped with
a table of contents, usage examples and an FAQ.
Also took some parts of the whitepaper that talk about
the node and API server deployment scenarios which are
of course very relevant here.

Fixes hyperledger-cacti#341

Signed-off-by: Peter Somogyvari <[email protected]>
petermetz added a commit to petermetz/cacti that referenced this issue Mar 25, 2021
@petermetz
docs(cmd-api-server): finish writing the readme file hyperledger-cact…
e9f725f 
…i#341

Added a README file for the API server equipped with
a table of contents, usage examples and an FAQ.
Also took some parts of the whitepaper that talk about
the node and API server deployment scenarios which are
of course very relevant here.

Fixes hyperledger-cacti#341

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz petermetz mentioned this issue Mar 25, 2021
Merged
petermetz added a commit to petermetz/cacti that referenced this issue Mar 26, 2021
@petermetz
docs(cmd-api-server): finish writing the readme file hyperledger-cact…
0d9109b 
…i#341

Added a README file for the API server equipped with
a table of contents, usage examples and an FAQ.
Also took some parts of the whitepaper that talk about
the node and API server deployment scenarios which are
of course very relevant here.

Fixes hyperledger-cacti#341

Signed-off-by: Peter Somogyvari <[email protected]>
petermetz added a commit that referenced this issue Mar 26, 2021
@petermetz
docs(cmd-api-server): finish writing the readme file #341
81c1f7f 
Added a README file for the API server equipped with
a table of contents, usage examples and an FAQ.
Also took some parts of the whitepaper that talk about
the node and API server deployment scenarios which are
of course very relevant here.

Fixes #341

Signed-off-by: Peter Somogyvari <[email protected]>
jordigiam pushed a commit to kikoncuo/cactus that referenced this issue Apr 8, 2021
@petermetz
docs(cmd-api-server): finish writing the readme file hyperledger-cact…
5578c0b 
…i#341

Added a README file for the API server equipped with
a table of contents, usage examples and an FAQ.
Also took some parts of the whitepaper that talk about
the node and API server deployment scenarios which are
of course very relevant here.

Fixes hyperledger-cacti#341

Signed-off-by: Peter Somogyvari <[email protected]>
ryjones pushed a commit that referenced this issue Feb 1, 2023
@sandeepnRES
Merge pull request #341 from sanvenDev/main
2307592 
Docs Updated with IIN Agent instructions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@petermetz petermetz

Labels
API_Server Developer_Experience documentation Improvements or additions to documentation good-first-issue Good for newcomers Hacktoberfest Hacktoberfest participants are welcome to take a stab at issues marked with this label.
Projects
None yet
Milestone
v1.0.0
Development

Successfully merging a pull request may close this issue.

docs(cmd-api-server): finish writing the readme file #341 petermetz/cacti
1 participant
@petermetz