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

docs: usage page in guides #1366

Merged
merged 17 commits into from Sep 26, 2022
Merged

docs: usage page in guides #1366

merged 17 commits into from Sep 26, 2022

Conversation

xDivisionByZerox
Copy link
Member

This PR moves the usage section from 'Getting started' in it's own page.

@xDivisionByZerox xDivisionByZerox requested a review from a team September 10, 2022 14:11
@xDivisionByZerox xDivisionByZerox requested a review from a team as a code owner September 10, 2022 14:11
@xDivisionByZerox xDivisionByZerox self-assigned this Sep 10, 2022
@xDivisionByZerox xDivisionByZerox added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent labels Sep 10, 2022
@xDivisionByZerox xDivisionByZerox added this to the v7 - Current Major milestone Sep 10, 2022
@codecov
Copy link

codecov bot commented Sep 10, 2022

Codecov Report

❗ No coverage uploaded for pull request base (main@7438a8a). Click here to learn what that means.
The diff coverage is n/a.

❗ Current head 23dc6fc differs from pull request most recent head c2a0732. Consider uploading reports for the commit c2a0732 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1366   +/-   ##
=======================================
  Coverage        ?   99.62%           
=======================================
  Files           ?     2163           
  Lines           ?   241275           
  Branches        ?     1013           
=======================================
  Hits            ?   240368           
  Misses          ?      886           
  Partials        ?       21           

docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
@xDivisionByZerox xDivisionByZerox marked this pull request as draft September 10, 2022 14:57
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
@xDivisionByZerox xDivisionByZerox marked this pull request as ready for review September 14, 2022 18:56
ST-DDT
ST-DDT previously approved these changes Sep 14, 2022
Co-authored-by: Shinigami <chrissi92@hotmail.de>
@xDivisionByZerox xDivisionByZerox requested a review from a team September 14, 2022 19:08
@xDivisionByZerox xDivisionByZerox requested a review from a team September 14, 2022 19:08
import-brain
import-brain previously approved these changes Sep 15, 2022
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
docs/guide/usage.md Outdated Show resolved Hide resolved
@Shinigami92
Copy link
Member

Nicely made, reads really fluent like a good tutorial blog post 👍
Would like to ship this soon

@Shinigami92 Shinigami92 linked an issue Sep 16, 2022 that may be closed by this pull request
@xDivisionByZerox
Copy link
Member Author

Nicely made, reads really fluent like a good tutorial blog post 👍 Would like to ship this soon

Thank you, this is really appreciated. Always discussing with myself if I should do stuff like a blog, but imposter syndrome is way to strong.

Co-authored-by: Eric Cheng <ericcheng9316@gmail.com>
@Shinigami92 Shinigami92 enabled auto-merge (squash) September 26, 2022 09:18
@Shinigami92 Shinigami92 merged commit 05aa969 into main Sep 26, 2022
@Shinigami92 Shinigami92 deleted the docs/usage-for-own-objects branch September 26, 2022 09:24
wael-fadlallah pushed a commit to wael-fadlallah/faker that referenced this pull request Oct 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add a documentation page for how to use faker to create own crafted objects Move usage section into own site
4 participants