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

Add full Windows dev env setup instructions #151

Merged

Conversation

Porges
Copy link
Contributor

@Porges Porges commented Jan 29, 2020

Link to deploy preview.

This (partially) addresses issue #146.

Copy link
Collaborator

@sharifsalah sharifsalah left a comment

Choose a reason for hiding this comment

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

Thanks @Porges for the contribution! This is really well put together for an initial draft.

If it's OK with you, I suggest we aim to merge this PR with a few changes that I think it makes sense for you to make. Then I can follow up with another PR to update the doc for style and clarity.

The kinds of things I'll update in a follow up PR are:

  • Change from future tense to present tense as much as possible
  • Clarify wording to improve localization and accessibility
  • Update formatting (for example bold instead of quotes for UI interaction)

How does that sound?

Thanks again!

content/contributing/opencue/getting-started-windows.md Outdated Show resolved Hide resolved
content/contributing/opencue/getting-started-windows.md Outdated Show resolved Hide resolved
content/contributing/opencue/getting-started-windows.md Outdated Show resolved Hide resolved
the “Privileges” tab, enable “Can login?”, then hit “💾 Save”.
1. **Create Database**: From the tree-view on the left, find “Databases”. Right-click it and
select “Create→Database…”. Name the database `opencue` and select the `opencue` user as
the owner, then hit “💾 Save”.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The icons are a nice touch, but we don't typically include these as they add to the maintenance overhead of the docs but add little benefit. I can clean these up after you merge the PR, so no need to worry about it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I’ve removed the icons for 💾 Save, however the reason I originally added them is that pgAdmin has icon-only buttons for the actions in the Query Editor. The two actions necessary are highlighted below:

Screenshot of pgAdmin query editor interface

@sharifsalah
Copy link
Collaborator

sharifsalah commented Jan 30, 2020

Oh by the way, here's the link to the fully rendered preview:

https://deploy-preview-151--elated-haibt-1b47ff.netlify.com/contributing/opencue/getting-started-windows/

I probably need to write some instructions to explain how to find these links :)

@Porges
Copy link
Contributor Author

Porges commented Jan 30, 2020

@sharifsalah thanks for reviewing. I’ve addressed all the main points, and have added commandline instructions as well for DB setup.

Copy link
Collaborator

@sharifsalah sharifsalah left a comment

Choose a reason for hiding this comment

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

LGTM, thanks again @Porges

@sharifsalah sharifsalah merged commit 16c63fa into AcademySoftwareFoundation:master Jan 31, 2020
@Porges Porges deleted the windows-setup-instructions branch February 2, 2020 20:51
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.

2 participants