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

Write a complete assertions guide #53

Open
joel-costigliola opened this issue Jun 24, 2016 · 6 comments
Open

Write a complete assertions guide #53

joel-costigliola opened this issue Jun 24, 2016 · 6 comments

Comments

@joel-costigliola
Copy link
Owner

Users are often not aware of useful assertions, a guide showing best practice assertions would help a lot.

@joel-costigliola
Copy link
Owner Author

joel-costigliola commented Jun 26, 2016

Reusing some part of http://www.baeldung.com/introduction-to-assertj would be a good idea.
Reuse the release notes examples.

@joel-costigliola
Copy link
Owner Author

joel-costigliola commented Jul 3, 2016

Add an Android section to address #54.

@joel-costigliola
Copy link
Owner Author

@filiphr
Copy link
Contributor

filiphr commented Aug 19, 2017

What are your plans for the guide? Do you plan to keep the same format as you have on the website currently?

Have you considered using Asciidoc with Asciidoctor. It is really similar to markdown and you can also include code snippets from tests which means that once a test is updated the documentation is updated as well 😄 . It is widely used in open source projects. For example Spring, Spring Boot, Hibernate, Vavr, MapStruct, and many more have moved their entire documentation into it. It creates HTML and it can create single HTML or multiple pages you can configure it.

If you decide to go for it, I would suggest you to have this asciidoc files in each project and it will be maintained as part of their release cycles, you then can include it into the website once you publish a release. If they are next to the projects it would be easier to maintain and you can include snippets from the tests into it.

@joel-costigliola
Copy link
Owner Author

I need to have a deeper look at it but that seems a really good idea.

@joel-costigliola
Copy link
Owner Author

started but a bit busy, check: https://assertj.github.io/doc/
PR would be awesome (in https://github.com/assertj/doc)

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

No branches or pull requests

2 participants