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

Document nearcore Release Process #2135

Closed
damons opened this issue Feb 13, 2020 · 5 comments
Closed

Document nearcore Release Process #2135

damons opened this issue Feb 13, 2020 · 5 comments
Assignees

Comments

@damons
Copy link

damons commented Feb 13, 2020

We are moving to scheduled releases, i.e., nightly, staging, testnet, and eventually mainnet. In order to do this, we must first document our current release process for staging. We will use this documentation to automate our release process as much as possible.

The output of this task will be to create a markdown file in the nearprotocol/docs repo describing the steps required to produce a release of nearcore.

@ghost
Copy link

ghost commented Feb 13, 2020

Write self documenting release scripts

@ailisp
Copy link
Member

ailisp commented Feb 19, 2020

Haven't find a very appropriate location to put this doc. Suggestions? https://docs.nearprotocol.com/docs/contribution/nearcore or https://docs.nearprotocol.com/docs/validator/staking-overview
Full possible places: https://github.com/nearprotocol/docs/tree/master/docs

@ghost
Copy link

ghost commented Feb 19, 2020

@ailisp , a possible solution:

add a "dev" folder in the root of the sources, there you can add any information relevant to (core) development. README would start with "this documentation addresses core-developers and external core-contributors, e.g. people which work on the near-protocol source-code itself"

So, dapp/asset/chain-related documentation goes to the docs sites (normal developers, the "customers")

core-dev related documentation goes to ./dev

@ghost
Copy link

ghost commented Feb 19, 2020

Just noticed this in the OP:

The output of this task will be to create a markdown file in the nearprotocol/docs repo

"docs" implies "standard documentation" (e.g. users/normal devs).

better to distinguish clearly (use of ./dev)

@ilblackdragon
Copy link
Member

Let's either use docs folder in this repo or contributing section in https://docs.nearprotocol.com/docs/contribution/nearcore

@ilblackdragon ilblackdragon modified the milestone: MainNet Mar 20, 2020
@bowenwang1996 bowenwang1996 self-assigned this Mar 31, 2020
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