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 Lazy Loading #1029

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Document Lazy Loading #1029

wants to merge 13 commits into from

Conversation

themacexpert
Copy link
Contributor

Description

Documents Lazy Loading on the Overview and Flags Page.

Checklist

  • I have added a label to this PR 🏷️
  • I have run my changes through Grammarly
  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

@themacexpert themacexpert added the A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.) label Nov 25, 2024
Copy link
Contributor

@albertov19 albertov19 left a comment

Choose a reason for hiding this comment

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

Added a comment. I would also add a warning stating that lazy loading is quite ram consuming or something. Maybe ask with MSL min ram requirements

Copy link
Contributor

@albertov19 albertov19 left a comment

Choose a reason for hiding this comment

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

Left some more feedback. Think that this is more a developer oriented tool. So it is important to document it also somewhere in the developer area, unsure where.

node-operators/networks/run-a-node/flags.md Outdated Show resolved Hide resolved
@themacexpert
Copy link
Contributor Author

Left some more feedback. Think that this is more a developer oriented tool. So it is important to document it also somewhere in the developer area, unsure where.

I found a place for it in the RPC endpoints section, since you'll need a dedicated endpoint to use Lazy Loading, it's a good home for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A2 - Maintenance Minor Pull request contains minor updates to an existing page (i.e., modifying parameters, steps, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants