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

docs: Move Localnet development to separate page #977

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

aefhm
Copy link
Contributor

@aefhm aefhm commented Oct 8, 2024

Description

Close #959

Note. Configuring Docusaurus redirect is not possible from an URL with an anchor.

message: '"redirects[54].from[0]" (/dapp/emerald/writing-dapps-on-emerald#running-a-private-oasis-network-locally) is not a valid pathname. Pathname should start with slash and not contain any domain or query string.',

TODO

  • run broken link checker

PREVIEW

@aefhm aefhm added the documentation Improvements or additions to documentation label Oct 8, 2024
@aefhm aefhm self-assigned this Oct 8, 2024
Copy link

netlify bot commented Oct 8, 2024

Deploy Preview for oasisprotocol-docs ready!

Name Link
🔨 Latest commit 42a2136
🔍 Latest deploy log https://app.netlify.com/sites/oasisprotocol-docs/deploys/6712d99acae7a40008a62007
😎 Deploy Preview https://deploy-preview-977--oasisprotocol-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@@ -79,91 +79,9 @@ ParaTime.
[Emerald Mainnet]: ./network.mdx
[Emerald Testnet]: ./network.mdx

## Running a Private Oasis Network Locally
#### For development and testing, you can run a local [instance][localnet]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
#### For development and testing, you can run a local [instance][localnet]
## For development and testing, you can run a local [instance][localnet]

Probably 2 # too much
I think having the old header and card to the localnet could be also a good way

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm. Yeah, ## is more consistent with "Testnet" etc. Let me try the text for now. I tend to think that the card takes the reader away from the flow of the document.

docs/dapp/tools/README.md Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.md Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.md Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.md Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.md Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.md Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.md Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.md Outdated Show resolved Hide resolved
@matevz matevz changed the title docs: Move localnet development to separate page docs: Move Localnet development to separate page Oct 11, 2024
@aefhm aefhm force-pushed the xz/959-localnet-section branch 3 times, most recently from 2a0e8e7 to 80db33b Compare October 14, 2024 11:54
docs/dapp/tools/localnet.mdx Outdated Show resolved Hide resolved
After a while, running the `sapphire-localnet` will show you something like:

```
sapphire-localnet 2024-05-28-git37b7166 (oasis-core: 24.0-gitfb49717, sapphire-paratime: 0.7.3-testnet, oasis-web3-gateway: 5.1.0)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think devs need duplicated info for Emerald.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think a output with a newer docker version would be good.
In this regard some info to update the docker image, with docker pull ghcr.io/oasisprotocol/sapphire-localnet:latest to get the latest version which includes ROFL, could be helpful for devs that used localnet already months ago.

@aefhm aefhm requested review from matevz and rube-de October 14, 2024 12:20
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

Added some ideas.

docs/dapp/tools/localnet.mdx Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.mdx Show resolved Hide resolved
docs/dapp/emerald/network.mdx Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.mdx Show resolved Hide resolved
docs/dapp/tools/localnet.mdx Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.mdx Outdated Show resolved Hide resolved
Copy link
Member

@matevz matevz left a comment

Choose a reason for hiding this comment

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

One more nit, otherwise LGTM.

docs/dapp/tools/localnet.mdx Outdated Show resolved Hide resolved
docs/dapp/tools/localnet.mdx Show resolved Hide resolved
@aefhm aefhm enabled auto-merge October 18, 2024 21:58
@aefhm aefhm merged commit c12bf0c into main Oct 18, 2024
2 checks passed
@aefhm aefhm deleted the xz/959-localnet-section branch October 18, 2024 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move the Localnet docker section into separate chapter
3 participants