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

[NoQA] Update "Troubleshooting" docs #5262

Merged
merged 4 commits into from
Sep 30, 2021

Conversation

kidroca
Copy link
Contributor

@kidroca kidroca commented Sep 15, 2021

Details

Describe some environment variables and specifically the USE_WEB_PROXY
as it causes issues for external contributors see slack thread🧵

Fixed Issues

N/A (Docs update)

Tests

N/A (Docs update)

QA Steps

N/A (Docs update)

Tested On

N/A (Docs update)

cc @Beamanator

@kidroca kidroca requested a review from a team as a code owner September 15, 2021 15:22
@MelvinBot MelvinBot requested review from mountiny and removed request for a team September 15, 2021 15:22
Describe some environment variables and specifically the USE_WEB_PROXY
as it's causes issues for external contributors
Beamanator
Beamanator previously approved these changes Sep 15, 2021
Copy link
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Love it!

README.md Outdated Show resolved Hide resolved
@kidroca
Copy link
Contributor Author

kidroca commented Sep 15, 2021

Updated,

@AndrewGable should I remove the ## Environment variables section?

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Great update! What do you think to create some @here post in #expensify-open-source as a questionnaire/survey to ask about the starting flow, what is confusing/what could be improved to start the App locally and start working.

Now we are busy, but it could be nice to explicitly ask for feedback instead of relying on people to show up. I think often people are afraid to say when they struggle with something/are confused, because they do not see other people ask about it and assume it is their mistake. @Beamanator @AndrewGable ? 👀

@kidroca kidroca changed the title Update "Getting Started" docs Update "Troubleshooting" docs Sep 15, 2021
@Beamanator
Copy link
Contributor

@mountiny that definitely sounds valuable to me, even @mateomorris posted in the Slack thread about some difficulties he had running the iOS app, so we'd probably get even more useful feedback by pinging everyone in Slack. Maybe we don't need to ping @here since it's not an announcement, but at least a public post would be very useful

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@AndrewGable
Copy link
Contributor

Asking sounds good, but I usually do not think people are afraid to ask if they are trying to get paid ASAP.

Co-authored-by: Andrew Gable <andrewgable@gmail.com>
@kidroca
Copy link
Contributor Author

kidroca commented Sep 29, 2021

Sorry @AndrewGable I've forgotten about this PR, just applied your suggested changes

@mountiny
Copy link
Contributor

@AndrewGable I see your point there, at the same time, there could be many junior developers trying to learn while also getting paid and I think that for those, it might be bigger barrier to step up and ask as they might feel it is a dumb question. Especially students, who might see this project as a great way to make some money while studying are example of someone who might not be confident enough in their skills yet so they could be hesitant to ask questions.

Asking for suggestions and feedback directly (I would even use @here tag in the open-source channel once we are don with getting the n6 out) would show our contributors that we care about their feedback and ideas and we want to get the process better not only for us and our employees, but also for them.

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Just couple minor styling suggestions.

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Contributor

@AndrewGable AndrewGable left a comment

Choose a reason for hiding this comment

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

Great improvement, thank you! @mountiny feel free to merge once you are happy with it. Also feel free to post anything in Slack, the more conversation and discussion about how to improve the set up, the better 😸

Copy link
Contributor

@mountiny mountiny left a comment

Choose a reason for hiding this comment

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

Great improvement!

README.md Show resolved Hide resolved
@mountiny mountiny merged commit 9daaa34 into Expensify:main Sep 30, 2021
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@mountiny mountiny changed the title Update "Troubleshooting" docs [NoQA] Update "Troubleshooting" docs Sep 30, 2021
@kidroca kidroca deleted the kidroca/docs-about-env branch September 30, 2021 11:46
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by @mountiny in version: 1.1.3-2 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

OSBotify commented Oct 4, 2021

🚀 Deployed to production by @chiragsalian in version: 1.1.4-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

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.

5 participants