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.

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

Add plugin section headers for auto-generated config.ini #1407

Closed
1 of 17 tasks
HarukaMa opened this issue Oct 30, 2018 · 5 comments
Closed
1 of 17 tasks

Add plugin section headers for auto-generated config.ini #1407

HarukaMa opened this issue Oct 30, 2018 · 5 comments
Assignees

Comments

@HarukaMa
Copy link
Contributor

HarukaMa commented Oct 30, 2018

User Story
As a node operator I want auto-generated config.ini have indications which options belong to which plugin so that it is not confusing.

Currently when creating a new data dir, automatically generated config.ini is populated with all possible options including those who belong to plugins. One can only infer which options are from core and which are from plugins by name (luckily es_plugin has very apparent prefixes).

Sometimes it could be confusing, see #1410.

It could be better if those options have clear indicators that which plugin they belong to, like:

...
# ==== market_history ====
...
# Will only store matched orders in last X seconds...
max-order-his-seconds-per-market = 2592000

# ==== delayed_node ====
# RPC endpoint of a trusted validating node (required)
# trusted-node =

# ==== snapshot ====
# Block number after which to do a snapshot
# snapshot-at-block =
...

Impacts
Describe which portion(s) of BitShares Core may be impacted by your request. Please tick at least one box.

  • API (the application programming interface)
  • Build (the build process or something prior to compiled code)
  • CLI (the command line wallet)
  • Deployment (the deployment process after building such as Docker, Travis, etc.)
  • DEX (the Decentralized EXchange, market engine, etc.)
  • P2P (the peer-to-peer network for transaction/block propagation)
  • Performance (system or user efficiency, etc.)
  • Protocol (the blockchain logic, consensus, validation, etc.)
  • Security (the security of system or user data, etc.)
  • UX (the User Experience)
  • Other (please add below)

CORE TEAM TASK LIST

  • Evaluate / Prioritize Feature Request
  • Refine User Stories / Requirements
  • Define Test Cases
  • Design / Develop Solution
  • Perform QA/Testing
  • Update Documentation
@oxarbitrage
Copy link
Member

I think this is a good idea however it is a bit tricky as the options passed to the config file does not contain from what plugin they came from. I am researching a bit on how it will be the best way to do it, if i cant find anything reasonable we should merge #1410 by now. Ill update soon.

@manikey123
Copy link
Contributor

claiming this and researching @ryanRfox

@pmconrad
Copy link
Contributor

@manikey123 this is already being worked on, see #1411

@abitmore
Copy link
Member

abitmore commented Mar 9, 2019

Please review #1641.

@abitmore abitmore assigned abitmore and unassigned oxarbitrage Mar 9, 2019
@oxarbitrage
Copy link
Member

closed by the great job of @abitmore here #1641

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants