bitshares/bitshares-core

proposal framework for api nodes documentation

Open

#650 opened on Feb 7, 2018

View on GitHub
 (4 comments) (1 reaction) (0 assignees)C++ (658 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (1,184 stars)
PR merge metrics
 (PR metrics pending)

Description

i am working on a draft to add to the wiki as i think we have no document to cover specifically the api node configuration:

https://github.com/oxarbitrage/worker-proposals/blob/master/bitshares_api_node.md

it is just a draft at the moment.

This will include https://github.com/bitshares/bitshares-core/issues/624 and https://github.com/bitshares/bitshares-core/issues/550

I will go ahead and get the commands for everything in there if you give me the ok to continue with it. Need help with securing the connection part as i never made it myself!

Contributor guide

Research direction
Review the draft proposal and existing BitShares documentation. Explore the codebase to understand API node configuration and verify commands. Focus on security aspects of node connections.
Tech stack
cppshell
Domain
apiinfrastructureblockchain
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70