Skip to content

docs: documentation for v0.16 #1086

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
Merged
merged 26 commits into from
May 24, 2021
Merged

docs: documentation for v0.16 #1086

merged 26 commits into from
May 24, 2021

Conversation

barriebyron
Copy link
Contributor

@barriebyron barriebyron commented May 4, 2021 •
edited
Loading

@fadeev do we have other v0.16 doc changes?
Noted:
Let's use this PR for documentation to be merged just before v0.16 release.

@barriebyron barriebyron requested a review from fadeev May 4, 2021 19:36
@barriebyron barriebyron self-assigned this May 4, 2021
@barriebyron barriebyron requested review from ilgooz and lumtis as code owners May 4, 2021 19:36
barriebyron
barriebyron commented May 4, 2021
View reviewed changes
barriebyron
barriebyron commented May 4, 2021
View reviewed changes
Copy link
Contributor Author

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we remove the protoc troubleshooting now that protoc is bundled?

@fadeev fadeev changed the title docs: remove node.js and protoc prereqs from install.md docs: documentation for v0.16 May 5, 2021
@fadeev fadeev marked this pull request as draft May 5, 2021 05:26
@fadeev
Copy link
Contributor

fadeev commented May 5, 2021

Let's use this PR for documentation that needs to be merged just before v0.16 release. Not before, because merging into develop triggers docs redeployment, and we, for example, don't want to remove protoc install instructions until we have v0.16 live.

@fadeev
Copy link
Contributor

fadeev commented May 5, 2021

@barriebyron added Docker instructions.

barriebyron
barriebyron commented May 6, 2021
View reviewed changes
Copy link
Contributor Author

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few questions for Ilker and me!

ilgooz
ilgooz reviewed May 11, 2021
View reviewed changes
Copy link
Member

@ilgooz ilgooz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @barriebyron, added some comments. 👍

Barrie Byron and others added 2 commits May 12, 2021 16:30
@ilgooz
Apply suggestions from Ilker's code review
3e88651 
commit the suggestions

Co-authored-by: İlker G. Öztürk <[email protected]>
Ilker's review comments
34b85ed
@barriebyron barriebyron requested a review from ilgooz May 12, 2021 20:43
@ilgooz
Copy link
Member

ilgooz commented May 14, 2021

We also need to create a "Troubleshooting > Placholders" page. Please see: #1136.

@fadeev
Copy link
Contributor

fadeev commented May 19, 2021

Moved content from intro.md files into index.md files to prevent showing empty index docs in starport docs. On the website it should look the same.

Screenshot 2021-05-19 at 16 53 09

barriebyron
barriebyron commented May 20, 2021
View reviewed changes
Copy link
Contributor Author

@barriebyron barriebyron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a question about accuracy of starport serve description

@ilgooz ilgooz linked an issue May 21, 2021 that may be closed by this pull request
docs: add usage instructions for starport-in-docker #1017
Closed
@ilgooz ilgooz added this to the v0.16 milestone May 21, 2021
@barriebyron barriebyron mentioned this pull request May 21, 2021
Merged
@barriebyron
Copy link
Contributor Author

@ilgooz I wasn't sure if we wanted to document --network host or use the port numbers as the document is now.
@fadeev and Ilker, I usually test my steps, but my M1 chip doesn't support the starport images on Docker, per #1110 so I didn't very all of the commands (or get to run them in Docker)

If required, feel free to make any changes directly to the docs. lmk what else I might be missing for this release. I'm still learning!

@fadeev fadeev marked this pull request as ready for review May 24, 2021 08:24
@fadeev fadeev requested a review from dshulyak as a code owner May 24, 2021 08:24
@ilgooz
Copy link
Member

ilgooz commented May 24, 2021

@barriebyron --network=host easy but only works for Linux. Mac users still needs to individually map the ports.

@ilgooz ilgooz merged commit 1c8553b into develop May 24, 2021
@ilgooz ilgooz deleted the install-v0.16-docs branch May 24, 2021 12:23
Jchicode pushed a commit to Jchicode/cli that referenced this pull request Aug 9, 2023
@fadeev @ilgooz
docs: documentation for v0.16 (ignite#1086)
3e3fb7d 
* remove node.js and protoc prereqs

* remove protoc troubleshooting

* Docker instructions

* Add client.vuex.path to config reference

* Improve readme on the website

* Added mnemonic in the config reference

* Replace Scaffold a Blockchain with Scaffolding

* still a few questions to figure out before this round of edits is complete

* just a few minor edit suggestions

* remove extra explanation and leave just the required steps and command information

* Apply suggestions from Ilker's code review

commit the suggestions

Co-authored-by: İlker G. Öztürk <[email protected]>

* Ilker's review comments

* Moved intro into index

* Removed links to /intro

* some docker updates, will get with Ilker for the rest, going to yoga class now

* serve no longer starts the vue app

* minor edits, start new line to introduce commands

* our style is title case for headings

* edits, but unable to test

Co-authored-by: Denis Fadeev <[email protected]>
Co-authored-by: İlker G. Öztürk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mikedizon mikedizon mikedizon left review comments

@fadeev fadeev Awaiting requested review from fadeev

@lumtis lumtis Awaiting requested review from lumtis

@ilgooz ilgooz Awaiting requested review from ilgooz

@dshulyak dshulyak Awaiting requested review from dshulyak

Assignees

@barriebyron barriebyron

Labels
None yet
Projects
None yet
Milestone
v0.16
Development

Successfully merging this pull request may close these issues.

docs: add usage instructions for starport-in-docker
4 participants
@barriebyron @fadeev @ilgooz @mikedizon