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

Add known issues page to docs #6378

Closed
nflaig opened this issue Jan 30, 2024 · 2 comments · Fixed by #6416
Closed

Add known issues page to docs #6378

nflaig opened this issue Jan 30, 2024 · 2 comments · Fixed by #6416
Assignees
Labels
scope-documentation All issues related to the Lodestar documentation.

Comments

@nflaig
Copy link
Member

nflaig commented Jan 30, 2024

As discussed in standup, we should set up a known issues page to mentioned common issues and make them searchable in the docs.

e.g. good candidate to start with is to document k8s / helm behavior in combination with Lodestar env vars

@nflaig nflaig added the scope-documentation All issues related to the Lodestar documentation. label Jan 30, 2024
@philknows philknows self-assigned this Jan 30, 2024
@philknows
Copy link
Member

I started on a draft template on an FAQs page. I'd like to make this page somewhat visually appealing as there may be a lot of content in here that should be easily discoverable and accessible. Was thinking of using admonitions such as this, but unsure if the question should remain in the title at all. Open for comments.
Screenshot 2024-01-30 at 5 31 43 PM

@nflaig
Copy link
Member Author

nflaig commented Jan 31, 2024

but unsure if the question should remain in the title at all

if we can formulate a precise title which is not too long I think that is likely the best solution

I am also not sure if for this specific issue a Question is the right term, because when you encounter this issue you don't even know it is related to environment variables as the error is really ambiguous.

The title would be rather something like "Unknown arguments error on Kubernetes" (or similar), and then we explain why it happens and how to resolve it.

make this page somewhat visually appealing as there may be a lot of content in here

Might be a bit verbose if we expect a lot of content to be listed here, generally a fan of simplicitly but if visual elemnts support readability I am all for it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope-documentation All issues related to the Lodestar documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants