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

Update dac documentation #882

Merged
merged 13 commits into from
Jan 26, 2024
Merged

Update dac documentation #882

merged 13 commits into from
Jan 26, 2024

Conversation

TucksonDev
Copy link
Contributor

@TucksonDev TucksonDev commented Jan 18, 2024

This PR updates the documentation available to configure a DAC.

Important notes:

  • Multiple partial views were created for this work. There's currently a limitation with Docusaurus that doesn't show headings of imported MD documents in the TOC of the right sidebar. Because the two main guides share a fair amount of content, and to avoid duplication as much as possible, partial views have been created for the content that is shared among both guides. This partial views don't include the headers of the sections, which are added directly to the main document to have them available in the TOC. Once that limitation is solved, we can reduce the number of partial views.
  • One of the styles has been slightly adjusted to allow for tabgroups without a "label".
  • Last page is not present as it is being worked on in this PR: docs for keyset generation on anytrust orbits #799 . An appropriate banner has been placed instead.
  • Placement of the section can be changed. It is now placed at the end of the Node running section, but can be moved somewhere else. We can prioritize publishing the doc before finding the best place for this docs too.

Preview

Copy link

vercel bot commented Jan 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nitro-docs ✅ Ready (Inspect) Visit Preview Jan 26, 2024 10:28am

@symbolpunk
Copy link
Contributor

In review

@TucksonDev
Copy link
Contributor Author

Thanks @Tristan-Wilson !
I've added a few more changes to the guides:

  • The main guide now doesn't mention the possibility of "disabling" the REST interface, but rather talks about running a mirror DAS to support your main DAS in handling REST requests.
  • Simplified the mirror DAS guide since it's now aimed at members who already have a main DAS running. Added a notice on top and redirections of the introductory sections to the main guides.
  • Rearranged some of the content to support those 2 changes (e.g., adding the "Archive" section to both guides.

Note: I've kept the partial views for now, until everything is good. Will remove those before merging.

Copy link
Member

@Tristan-Wilson Tristan-Wilson left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@symbolpunk symbolpunk left a comment

Choose a reason for hiding this comment

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

This is a beast of a PR... lots of misc nits, no blocking feedback. TYVM 🙏

title: 'How to configure a Data Availability Committee: configure the DAC in your chain'
description: This how-to will help you configure the DAC in your chain.
author: jose-franco
sidebar_label: Configure the DAC in your chain
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
sidebar_label: Configure the DAC in your chain
sidebar_label: Configure a Data Availability Committee (DAC)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Modified the sidebar to "How to configure the Data Availability Committee (DAC) in your chain" since this document is specific about one step of the process and having the same title as the section might be confusing for users. I kept the suggested convention.

@@ -0,0 +1,12 @@
---
title: 'How to configure a Data Availability Committee: configure the DAC in your chain'
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
title: 'How to configure a Data Availability Committee: configure the DAC in your chain'
title: 'How to configure a Data Availability Committee (DAC)'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Modified the title too, as specified here.

@TucksonDev TucksonDev merged commit 9c91d61 into master Jan 26, 2024
2 checks passed
@TucksonDev TucksonDev deleted the update-dac-documentation branch January 26, 2024 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants