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

Split publishing workflows #1781

Merged
merged 6 commits into from
Oct 24, 2024
Merged

Conversation

jdbaldry
Copy link
Member

@jdbaldry jdbaldry commented Oct 23, 2024

What?

Split k6 and k6-studio documentation so they can be published independently.

Because I've moved all the k6-docs, there's a big patch. Look at the individual commits in https://github.com/grafana/k6-docs/pull/1781/commits.

Self-review included running make docs and browsing to both http://localhost:3002/docs/k6/ and http://localhost:3002/docs/k6-studio/.

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.

Related PR(s)/Issue(s)

Closes https://github.com/grafana/website/issues/22312

Signed-off-by: Jack Baldry [email protected]

Signed-off-by: Jack Baldry <[email protected]>
Signed-off-by: Jack Baldry <[email protected]>
Signed-off-by: Jack Baldry <[email protected]>
Signed-off-by: Jack Baldry <[email protected]>
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry force-pushed the jdb/2024-10-publish-k6-studio branch from 052bcdb to ea5285e Compare October 23, 2024 13:34
@jdbaldry jdbaldry marked this pull request as ready for review October 23, 2024 14:44
@jdbaldry jdbaldry force-pushed the jdb/2024-10-publish-k6-studio branch from 14fc033 to 63b8673 Compare October 23, 2024 14:52
Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry force-pushed the jdb/2024-10-publish-k6-studio branch from 63b8673 to 27e10cc Compare October 23, 2024 14:56
@heitortsergent
Copy link
Collaborator

@jdbaldry I can build this locally and it works great! Is there something we need to do to make sure the doc-validator works correctly for this PR, or should the change in this PR already do the trick once it's merged to main? 🤔

@jdbaldry
Copy link
Member Author

I think it's failing because the PR diff is so large and it can't handle it.

Unfortunately, the same thing will happen on your PR after we merge this into that so I guess we'll need to just ignore the checks this time around.

@heitortsergent
Copy link
Collaborator

Ok! I'll merge this then before I make more changes to the k6 studio docs. :)

Thanks @jdbaldry! 🙇

@heitortsergent heitortsergent merged commit ac65e30 into hts/k6-studio Oct 24, 2024
1 of 2 checks passed
@heitortsergent heitortsergent deleted the jdb/2024-10-publish-k6-studio branch October 24, 2024 13:43
heitortsergent added a commit that referenced this pull request Oct 27, 2024
heitortsergent added a commit that referenced this pull request Oct 28, 2024
* Add k6 studio docs folder

* Add basic structure to Get started tutorial

* Update Google Chrome URL

* Fill out Create a test recording for get started guide

* Add content to Components index page

* Add content to Test Recorder page

* Update test recorder action buttons section

* Split publishing workflows (#1781)

* Split publishing workflows

Signed-off-by: Jack Baldry <[email protected]>

* Move k6 docs to subdirectory

Signed-off-by: Jack Baldry <[email protected]>

* Update script example

Signed-off-by: Jack Baldry <[email protected]>

* Add k6-studio to Makefile

Signed-off-by: Jack Baldry <[email protected]>

* Fix doc-validator for k6

Signed-off-by: Jack Baldry <[email protected]>

* Use awk not grep

Signed-off-by: Jack Baldry <[email protected]>

---------

Signed-off-by: Jack Baldry <[email protected]>

* Add Test Generator draft

* Add Test Validator structure

* Add Test Generator screenshot

* Add Test Validator draft

* Remove k6 studio content

---------

Signed-off-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
heitortsergent added a commit that referenced this pull request Oct 31, 2024
* Add k6 studio docs folder

* Add basic structure to Get started tutorial

* Update Google Chrome URL

* Fill out Create a test recording for get started guide

* Add content to Components index page

* Add content to Test Recorder page

* Update test recorder action buttons section

* Split publishing workflows (#1781)

* Split publishing workflows

Signed-off-by: Jack Baldry <[email protected]>

* Move k6 docs to subdirectory

Signed-off-by: Jack Baldry <[email protected]>

* Update script example

Signed-off-by: Jack Baldry <[email protected]>

* Add k6-studio to Makefile

Signed-off-by: Jack Baldry <[email protected]>

* Fix doc-validator for k6

Signed-off-by: Jack Baldry <[email protected]>

* Use awk not grep

Signed-off-by: Jack Baldry <[email protected]>

---------

Signed-off-by: Jack Baldry <[email protected]>

* Add Test Generator draft

* Add Test Validator structure

* Add Test Generator screenshot

* Add Test Validator draft

* Revert "Split publishing workflows (#1781)"

This reverts commit ac65e30.

* Update docs/sources/k6-studio/components/_index.md

Co-authored-by: Llandy Riveron Del Risco <[email protected]>

* Update docs/sources/k6-studio/components/test-generator.md

Co-authored-by: Llandy Riveron Del Risco <[email protected]>

* Update docs/sources/k6-studio/components/test-recorder.md

Co-authored-by: Llandy Riveron Del Risco <[email protected]>

* Add Test Generator screenshot

* Update Test Validator screenshot

* Update card descriptions

* Llandy feedback

* Llandy feedback

* Update docs structure

* Add Test Validator screenshot description

* Update the Validate external script section

* Add Parameterization rule description

* Add Troubleshooting content

* Add information about Usage collection

* Fix component links

* Update troubleshooting.md

* Add Settings page content

* Small edits

* Add Components card to homepage

* Update introduction screenshot

* Update screenshots

Use public preview version and figure shortcode

* Fix tutorial screenshot and installation link

* Add k6 Studio get started (#1787)

* Rename Troubleshooting to Troubleshoot

* k6 Studio tutorial edits

* More k6 Studio tutorial edits

* Add tutorial screenshots

* k6 Studio docs adjustement (#1793)

* upstream note

* fix input in record first script

* generator fixes

* More edits

---------

Signed-off-by: Jack Baldry <[email protected]>
Co-authored-by: Jack Baldry <[email protected]>
Co-authored-by: Llandy Riveron Del Risco <[email protected]>
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