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

Many updates #27

Merged
merged 10 commits into from
Dec 11, 2023
Merged

Many updates #27

merged 10 commits into from
Dec 11, 2023

Conversation

jbowen93
Copy link
Member

Description

Made significant updates to the doc structure.

  • Deleted Local Dev Cluster section
  • Deleted sections for Azure, GCP, and AWS (to be re-added once they're updated)
  • Moved rollup deployment to top level on sidebar
  • Updated copy in Digital Ocean guide

Motivation and Context

Screenshots (if appropriate):

Types of changes

  • Edits to existing documentation
  • Changing documentation structure (relocating existing files, ensure redirects exist)
  • Stylistic changes (provide screenshots above)

@jbowen93 jbowen93 changed the base branch from main to dusk-2 December 11, 2023 15:41
label: 'Astria Dusknet',
to: '/docs/dusknet/overview/',
label: 'Local Rollup on Dusknet',
to: '/docs/local-rollup/introduction/',
Copy link
Member

Choose a reason for hiding this comment

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

We should consider using redirects for things that changed location/what we want people to nav to instead: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-client-redirects

Copy link
Member Author

Choose a reason for hiding this comment

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

Noted, this is a pretty significant restructuring of the docs so I'm not sure this applies. Is this for SEO reasons?

Copy link
Member

Choose a reason for hiding this comment

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

Yes + people having dead links is bad.

Of chance someone has a bookmark, if someone gets a stale search crawl, etc.

@jbowen93 jbowen93 marked this pull request as ready for review December 11, 2023 20:25
@sambukowski
Copy link
Contributor

sambukowski commented Dec 11, 2023

nit:
in local-rollup/introduction in the Create a New Sequencer Account section the private key text in the output and env var input aren't the same:
example:

Private Key: "5562...1622" # <SEQUENCER_ACCOUNT_PRIV_KEY>
Public Key:  "ec20...f613" # 
Address:     "8a2f...5f68" # <SEQUENCER_ACCOUNT_ADDRESS>

Export your sequencer private key and address as environment variables:

export SEQUENCER_PRIV_KEY=9c78...710d
export SEQUENCER_ACCOUNT_ADDRESS=8a2f...5f68

The line export SEQUENCER_PRIV_KEY=9c78...710d should be export SEQUENCER_PRIV_KEY=5562...1622

link:

export SEQUENCER_PRIV_KEY=9c78...710d

@sambukowski
Copy link
Contributor

sambukowski commented Dec 11, 2023

This is also the case in the Digital Ocean docs in the same section.

link:

export SEQUENCER_PRIV_KEY=9c78...710d

@jbowen93 jbowen93 merged commit 2984698 into dusk-2 Dec 11, 2023
1 check passed
@jbowen93 jbowen93 deleted the many-updates branch December 11, 2023 21:35
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

Successfully merging this pull request may close these issues.

3 participants