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

Update documentation for EFCore_WebApi example #2054

Conversation

omelianlevkovych
Copy link
Contributor

Description

Updated the documentation readme file for the example project.

Reasoning behind the change

While doing onboarding I have faced few obstacles.
It was considered that documentation update will be helpful. Therefore newcomers will not have to face same issues.

Additional changes

I have added table of content and fixed some typos.

highlighted the adapters and ports pattern
added more information on troubleshooting
highlited the outbox pattern as a separate subtopic
@CLAassistant
Copy link

CLAassistant commented Mar 29, 2022

CLA assistant check
All committers have signed the CLA.

@omelianlevkovych
Copy link
Contributor Author

Unfortunately, I haven't really used much github yet. In case I do need to link an issue somehow here, please, let me know.

Also I have a few additional questions.

  • We do have docker-compose file in the example folder, however I failed to run it. What I am doing wrong, and what is the initial purpose of that file (we do have docker compose files in root folder already).
  • In case it the docker compose file somehow can be used, can we add phpmyadmin as well. The GUI can be really helpful for folks who haven't used the MySQL a lot yet.
  • We also have a build.sh file. Do we want powershell scrip as well for the Windows users. Is it even a forbidden question in the open source community 😆 ? I am not sure whether it is possible to run build.sh script on Windows OS.

Copy link
Member

@iancooper iancooper left a comment

Choose a reason for hiding this comment

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

These look really helpful

@iancooper
Copy link
Member

We do have docker-compose file in the example folder, however I failed to run it.
OK, I'll add it to my list of things to investigate, alongside the failing global inbox switch

In case it the docker compose file somehow can be used, can we add phpmyadmin as well.
Not used that before - so something for me to investigate (I tend to use DataGrip)

We also have a build.sh file. Do we want powershell scrip as well for the Windows users.
We can, I am just on a Mac so it would be hard to test. Some of the other maintainers are on Windows machines though. We don't have a preference as to the OS :-D

Copy link
Member

@preardon preardon 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 to me, thanks for putting the effort in :)

@omelianlevkovych omelianlevkovych changed the title Update documentation for EFCore_WebApi example WIP Update documentation for EFCore_WebApi example Mar 30, 2022
@iancooper iancooper merged commit 4f47f2f into BrighterCommand:master Mar 30, 2022
@omelianlevkovych omelianlevkovych deleted the update_doc_for_efcore-webapi_example branch March 30, 2022 17:00
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

Successfully merging this pull request may close these issues.

4 participants