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.

Sign up for GitHub

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

Jump to bottom

docs: simple index + add docs on test / docker #8181

Merged
merged 3 commits into from
Mar 10, 2023
Merged

docs: simple index + add docs on test / docker #8181

merged 3 commits into from
Mar 10, 2023

Conversation

alexgarel
Copy link
Member

@alexgarel alexgarel commented Mar 10, 2023 •
edited
Loading

  • do not copy README as index anymore (too confusing)
  • have a specific sleek index.md instead
  • publish doc on makefile targets for docker
  • add a doc on writing and running tests

fixes:

@alexgarel alexgarel requested a review from a team as a code owner March 10, 2023 14:11
@github-actions github-actions bot added 🐋 Docker https://docker-curriculum.com/ 📚 Documentation Documentation issues improve the project for everyone. labels Mar 10, 2023
@alexgarel alexgarel changed the title docs: simple index + add docs on test / docker docs: simple index + add docs on test / docker Mar 10, 2023
stephanegigandet
stephanegigandet approved these changes Mar 10, 2023
View reviewed changes
Copy link
Contributor

@stephanegigandet stephanegigandet left a comment

Choose a reason for hiding this comment

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

Looks good, thank you!

@alexgarel @stephanegigandet
docs: small typos
4472951 
Co-authored-by: Stéphane Gigandet <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Mar 10, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@alexgarel alexgarel merged commit e4085c7 into main Mar 10, 2023
@alexgarel alexgarel deleted the docs-no-index-readme branch March 10, 2023 18:52
@openfoodfacts-bot openfoodfacts-bot mentioned this pull request Mar 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stephanegigandet stephanegigandet stephanegigandet approved these changes

Assignees

@alexgarel alexgarel

Labels
🐋 Docker https://docker-curriculum.com/ 📚 Documentation Documentation issues improve the project for everyone.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@alexgarel @stephanegigandet