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

Add Frequently Asked Questions page #178

Merged
merged 2 commits into from
Oct 11, 2023
Merged

Add Frequently Asked Questions page #178

merged 2 commits into from
Oct 11, 2023

Conversation

picimako
Copy link
Contributor

This PR contains the introduction of an FAQ page. It could be used to store answesr to various questions that might not necessarily fit into other documentation topic, and to preserve knowledge from the WireMock Community Slack.

Notes:

  • If you think the currently included question and answer would be a better fit for a different page, let me know.
  • Please advise on the page title and meta information, if it should be something else, or should be placed somewhere else.

References

Submitter checklist

  • The PR request is well described and justified, including the body and the references
  • The PR title represents the desired changelog entry
  • If the change against WireMock 2 functionality (incompatible with WireMock 3),
    it is submitted against the 2.x branch
  • The repository's code style is followed (see the contributing guide)

Details: Contributor Guide


#### Potential solutions for WireMock standalone
- Use configuration-as-code, and store your definitions in a repository. You can have a hierarchical structure of Mappings and Files to specify teams.
- Disabling the modifying APIs after moving to configuration-as-code is also highly recommended, so that teams cannot break each other's mocks.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@oleg-nenashev Do you know what did you mean by modifying APIs and how it can be done? If there is a documentation for it, I'd like to include it.

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

I would call the page "faq" in the URL. Note that there is also a FAQ section on the landing, and maybe we want to copy the content from there.

image

@picimako
Copy link
Contributor Author

Oh, I was not aware of that FAQ page. I'll change the url to 'faq' and move those contents over. Thank you.

@picimako
Copy link
Contributor Author

picimako commented Oct 2, 2023

@oleg-nenashev I added the changes.
Could you also please check my question above regarding the mapping structuring question?

Copy link
Member

@oleg-nenashev oleg-nenashev left a comment

Choose a reason for hiding this comment

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

+1 from me, sorry for the review delay

@oleg-nenashev
Copy link
Member

The build failure is unrelated, merging
Thanks a lot @picimako !

@oleg-nenashev oleg-nenashev added the documentation Improvements or additions to documentation label Oct 11, 2023
@oleg-nenashev oleg-nenashev merged commit b6d50bf into wiremock:main Oct 11, 2023
1 check failed
@picimako picimako deleted the faq branch October 11, 2023 14:24
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants