Update Getting Started DocC Documentation for the Firebase Emulator #313
Conversation
setup the firebase emulator
made some changes about flutter emulator setup
added firebase emulator setup tutorial
fixed typos
mikaelacaron
changed the title
There was a problem hiding this comment.
You're almost there! I have several comments that need resolved mainly related to formatting. If you have any questions, you can comment directly on that thread, otherwise click the resolve button once you've addressed my comment. Once you fix everything, please click the re-review button
And note that the "Start Working on an Issue" section should be updated as well, so that it matches the contributing file. showing a screenshot of the Firebase emulator would be great too!
You don't need to close the PR, just make your changes, commit and push them, the PR will update automatically
Basic-Car-Maintenance/Documentation.docc/getting-started.tutorial
Outdated
Show resolved
Hide resolved
Basic-Car-Maintenance/Documentation.docc/getting-started.tutorial
Outdated
Show resolved
Hide resolved
Basic-Car-Maintenance/Documentation.docc/getting-started.tutorial
Outdated
Show resolved
Hide resolved
Basic-Car-Maintenance/Documentation.docc/getting-started.tutorial
Outdated
Show resolved
Hide resolved
fixed some typos
README.md
Outdated
| @@ -3,7 +3,7 @@ | |||
|  | |||
|  | |||
| [](https://www.firsttimersonly.com/) | |||
| [](https://github.com/mikaelacaron/Basic-Car-Maintenance/actions/workflows/unit-tests.yml) | |||
| [![Unit Tests]()](https://github.com/mikaelacaron/Basic-Car-Maintenance/actions/workflows/unit-tests.yml) | |||
There was a problem hiding this comment.
What's this do? it's not described in the PR description what this change is for, and it's unrelated to this PR, if you want to change something unrelated, make a new issue describing what the change is and why
There was a problem hiding this comment.
That happened unintentionally due to oversight! Apologies.
There was a problem hiding this comment.
nothing in the README.md file should be changed
| @@ -88,6 +88,53 @@ | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| @Section(title: "Setting Up Firebase Local Emulator") { | |||
There was a problem hiding this comment.
You need to build the documentation locally, step 1 doesn't have a line braek between the text and then the command
step 2 and many others are now missing text because using --- does not work for an interactive tutorial
Here's Apple's documentation about how to build a DocC interactive tutorial
https://www.swift.org/documentation/docc/building-an-interactive-tutorial
There was a problem hiding this comment.
while this now renders better, many new warnings are created because using underscores doesn't fix this issue. Refer to the documentation to properly format the document
There was a problem hiding this comment.
It doesn't seem like you ran this locally to fix the issues, see attached screenshot with the 10+ warnings happened because of a result of your change
this is the last time I'm going to review this, or this PR will be marked as spam.
The README was also not resolved and is still showing changes, when it shouldn't
| @@ -88,6 +88,53 @@ | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| @Section(title: "Setting Up Firebase Local Emulator") { | |||
There was a problem hiding this comment.
while this now renders better, many new warnings are created because using underscores doesn't fix this issue. Refer to the documentation to properly format the document
I apologize for the oversight. I was away from my PC and had to make the changes manually while referring to the documentation and other guides.
I apologise for this, I am still learning and will ensure I follow the guidelines more carefully.
I believe the issue has been resolved now. Please let me know if it’s not, and I would be happy to make any necessary adjustments. |
Basic-Car-Maintenance/Documentation.docc/getting-started.tutorial
Outdated
Show resolved
Hide resolved
Basic-Car-Maintenance/Documentation.docc/getting-started.tutorial
Outdated
Show resolved
Hide resolved
README.md
Outdated
| @@ -3,7 +3,7 @@ | |||
|  | |||
|  | |||
| [](https://www.firsttimersonly.com/) | |||
| [](https://github.com/mikaelacaron/Basic-Car-Maintenance/actions/workflows/unit-tests.yml) | |||
| [![Unit Tests]()](https://github.com/mikaelacaron/Basic-Car-Maintenance/actions/workflows/unit-tests.yml) | |||
There was a problem hiding this comment.
nothing in the README.md file should be changed
I've made the changes for merging this PR. Thank you for contributing. I am fully open to having beginners contribute to this repo. After seeing two revisions of your PR with minimal changes, and not addressing my comments, this seemed like a spam PR. (a problem with Hacktoberfest has overall) I do hope you continue to contribute and that this isn't discouraging. Is there something in the wording of my comments when reviewing your PR, that I can do to make it more clear what I was looking for you to change? |
Thank you for merging the PR and for your understanding. I’m still learning and trying to get the process right, and I realize now that I should have been more thorough in addressing each point.
Your comments were clear, but I might have misunderstood some of the details, which led to the missed corrections. Though, I wasn't able to figure a way out to add a horizontal line break in the linked documentation you provided. |
|
You should've looked how it's done in the previous steps that I referenced. Building the project allows you to see how it was done in steps that were already existing
|
What it Does
How I Tested
Notes
Screenshot