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

EPIC: Restructure the examples to use code tabs #183

Open
oleg-nenashev opened this issue Sep 28, 2023 · 6 comments
Open

EPIC: Restructure the examples to use code tabs #183

oleg-nenashev opened this issue Sep 28, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@oleg-nenashev
Copy link
Member

Proposal

In WireMock documentation, there are A LOT of examples where JSON and Code examples are placed in separate examples which takes a lot of vertical space and complicates the documentation. Instead of that, it would be nice if the examples were put into recently introduced Code Tabs like this one:

image

Steps

Each case can be submitted as a separate pull request:

  • Find a case when two examples (usually JSON and Java) are placed sequentially
  • Merge examples into a single block using the {codetabs} macro
  • Copy-edit text around examples to ensure it is consistent

Example of a patch: #165

References

No response

@oleg-nenashev oleg-nenashev added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Sep 28, 2023
@Smartmind12
Copy link
Contributor

@oleg-nenashev I would like to work on this issue!

Smartmind12 added a commit to Smartmind12/wiremock.org that referenced this issue Oct 1, 2023
Reducing vertical space in documentation using code tabs. 

Related to wiremock#183
@Smartmind12 Smartmind12 mentioned this issue Oct 1, 2023
4 tasks
@oleg-nenashev
Copy link
Member Author

@Smartmind12 sure, thanks for your interest!

Smartmind12 added a commit to Smartmind12/wiremock.org that referenced this issue Oct 1, 2023
Documentation updation part of wiremock#183
@oleg-nenashev oleg-nenashev added the hacktoberfest Hacktoberfest ideas label Oct 6, 2023
@Smartmind12
Copy link
Contributor

Smartmind12 commented Oct 9, 2023

@Smartmind12 sure, thanks for your interest!

As for other pages i will push the PR today and tomorrow post working in them!

@oleg-nenashev
Copy link
Member Author

@Smartmind12 thanks, great job!

@Smartmind12
Copy link
Contributor

@oleg-nenashev I went through the docs and the merged changes look great! However the cases of groovy gradle thos seem to have an issue in tabs. I tried to locate the issue but could not, so can you look at it to provide a different POV!?

@oleg-nenashev oleg-nenashev removed good first issue Good for newcomers hacktoberfest Hacktoberfest ideas labels Dec 8, 2023
@oleg-nenashev
Copy link
Member Author

I am parking this ticket for now, because #228 restructures the code tabs logic, and it would be better to submit the patches against the new engine

@oleg-nenashev oleg-nenashev added the good first issue Good for newcomers label Dec 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants