search

pact-foundation / docs.pact.io

Pact documentation website
17 stars 97 forks source link

Usability: Unable to find installation instructions #7

Open RedSwift opened 4 years ago

RedSwift commented 4 years ago

I tried navigating around but I couldn't seem to find any references on how to install pact on the website.

Perhaps it was because we would want pact to be language agnostic and hence didn't provide installation instructions (since each environment is different).

However, I believe it might be beneficial to add a section in the guides or docs to let users know to refer to their respective language repositories for further instructions on installation (like NPM for node users) or maybe just a summary of initial steps?

Thanks for the great work!

bethesque commented 4 years ago

Yes, you raise a very good point, and it's something we're aware of. At the moment, the docs just point you out to the site for each of the relevant implementations because we haven't had a way to bring all those docs back into one place. We've just migrated to a docs solution that gives us much more control over the content, so it's on my TODO list to automatically pull in the README document for each of the languages and embed them inside the docs site.

RedSwift commented 4 years ago

Really exciting news to hear! It's the first time i am actually posting an issue so not really sure if I am supposed to close this or leave it open.

Let me know if I need to close the issue seeing that the team will be addressing it soon :)

bethesque commented 4 years ago

Leave it open. It's nice having something to check off when things get done.

bethesque commented 4 years ago

Done Pact-JS.

https://docs.pact.io/implementation_guides/javascript/readme#installation

Now to do all the other languages...

YOU54F commented 2 years ago

Might be nice to add an installation section in the list

Screenshot 2022-03-17 at 19 21 03

Current state of play