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

Getting Started Guide #306

Merged
merged 17 commits into from
Nov 18, 2024
Merged

Getting Started Guide #306

merged 17 commits into from
Nov 18, 2024

Conversation

kchason
Copy link
Member

@kchason kchason commented Oct 23, 2024

  • Following the Adoption Committee meeting, a discussion arose around a code-first getting started guide.
  • Contributions are welcome.

To setup the local environment for development and testing:

docker compose up -d --build

This will make the Jekyll site available on port 4000 on localhost.

@kchason kchason self-assigned this Oct 23, 2024
@kchason kchason marked this pull request as ready for review November 13, 2024 15:41
@kchason kchason requested a review from a team as a code owner November 13, 2024 15:41
@ajnelson-nist
Copy link
Member

I've added a table of contents macro call and re-adjusted the heading-levels. This helped me eyeball the document section-flow.

Copy link
Member

@ajnelson-nist ajnelson-nist left a comment

Choose a reason for hiding this comment

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

Assuming CI passes, I think this PR is ready for review and merge.

I added some generated results, but did not yet apply the Make practices that keep the Markdown in line with generated data as done with the examples gallery. I plan to propose that after this PR, because it will help keep an eye on this page and catch any drift.

@kchason , it would be good for you to review the English updates. If you approve, please feel free to merge.

@kchason kchason merged commit dc6cdcf into master Nov 18, 2024
1 check passed
@kchason kchason deleted the getting-started-page branch November 18, 2024 13:41
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.

2 participants