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 local development pre-requisites #1476

Open
immavalls opened this issue Jan 14, 2024 · 0 comments
Open

Update local development pre-requisites #1476

immavalls opened this issue Jan 14, 2024 · 0 comments
Assignees
Labels
Type: Good first issue Good for newcomers

Comments

@immavalls
Copy link
Contributor

With the recent changes, we can now run the docs locally if npm has already been installed.

We need to update the docs to mention that this is optional. If npm is installed run npm start,. If not, and we only have docker/podman, continue running cd docs && make docs.

Worth mentioning that with legacy docs we can still run them locally as in https://github.com/grafana/k6-docs/tree/addExperimentalTimers?tab=readme-ov-file#install-and-run-in-docker. Might be worth keeping a separate page about how to test the legacy docs linked from https://github.com/grafana/k6-docs/blob/main/CONTRIBUTING/README.md#build-locally?

@immavalls immavalls added the Type: Good first issue Good for newcomers label Jan 14, 2024
@immavalls immavalls self-assigned this Jan 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant