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

Reorganize disruptor get-started #1356

Merged
merged 3 commits into from
Oct 16, 2023
Merged

Conversation

pablochacin
Copy link
Contributor

@pablochacin pablochacin commented Oct 3, 2023

Make the get started section more to the point and actionable.
Move the introduction to a new "About" page

There's a version of the docs published here:
https://mdr-ci.staging.k6.io/docs/refs/pull/1356/merge/javascript-api/xk6-disruptor/

@ppcano
Copy link
Collaborator

ppcano commented Oct 3, 2023

@pablochacin,

1 - should this link go to the About or First steps page?

Screenshot 2023-10-03 at 22 56 26

2- Also, first-steps URL is 404
https://mdr-ci.staging.k6.io/docs/refs/pull/1356/merge/javascript-api/xk6-disruptor/get-started/first-steps/

@pablochacin
Copy link
Contributor Author

pablochacin commented Oct 4, 2023

@ppcano

  1. The main purpose of the PR is to make the "landing" page of the disruptor API more "actionable" than descriptive, based on some feedback we got from people trying to use it. Therefore I think it should point to First Steps instead of About.

Please notice that About is basically the same previous Welcome page that is currently the entry page for the disruptor. Making it the "landing page" will basically keep things as they are now.

  1. The page is there and it is possible to navigate to ti from the side panel and the drop-down menu. Any idea how to fix this? I'm not sure how this navigation works.

@roobre
Copy link
Contributor

roobre commented Oct 4, 2023

I'm not 100% convinced about how the new landing page helps avoid making the user jump around. I think another possible way to address the feedback would be to create an additional, less detailed end to end journey (we could call that "quick start", or "get started"). This page would not include any description (I think it is well captured in the "Welcome" page), and instead I'd put on it all the steps that are required to get a first test running. Something like:

  1. Requirements: Command to check you have a valid kubeconfig, maybe come kubectl auth can-i
  2. Installation: Quickest way to get the binary, maybe a curl/wget to the latest release
  3. Expose application: Simplest possible way, probably port-forward
  4. Run the test: Including a ready-to-use snippet.
  5. Learn more: Links to the API

Each of these sections could have a link to their expanded, own-page version.

WDYT about this approach?

@pablochacin
Copy link
Contributor Author

pablochacin commented Oct 4, 2023

I'm not 100% convinced about how the new landing page helps avoid making the user jump around.

@roobre I agree. For me this is a first step, reorganizing the content that lands in a list of first steps.

The changes you suggest could be done in a follow-up PR, replacing the current first steps.

@ppcano
Copy link
Collaborator

ppcano commented Oct 11, 2023

I didn't remember this but it seems the issue is that redirects don't work with the mdr-ci.staging.k6.io.

curl -I https://mdr-ci.staging.k6.io/docs/refs/pull/1356/merge/es/guias-de-prueba/automatizacion-de-pruebas-de-rendimiento/ HTTP/2 404

curl -I https://staging.k6.io/docs/es/guias-de-prueba/automatizacion-de-pruebas-de-rendimiento/ HTTP/2 301 

So the redirect should work when deployed to staging or production.

Also, changed fa09ab9 which relates to https://k6.io/docs/get-started/welcome/

@pablochacin pablochacin merged commit 0041334 into main Oct 16, 2023
5 checks passed
@pablochacin pablochacin deleted the reorganize-disruptor-get-started branch October 16, 2023 08:33
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.

3 participants