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-user-Getting Started adjustments #4365

Merged
merged 14 commits into from
Feb 3, 2023
Merged

Conversation

LiborBatek
Copy link
Member

Brief description

Small typo fixes here and there, additional info on install/ running OP.


or alternatively by using

**openpype_console.exe** located in the OpenPype folder which is suitable for TDs/admins for debugging and error reporting. It opens console window where all the necessary information will appear during user's work.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Aren't both executables located in that folder? I'd either mention it prior to both or not mention it only here. This makes it feel like openpype_gui.exe is NOT located there and leaves me wondering where openpype_gui.exe would be located.

Comment on lines 21 to 25
Installing OpenPype is possible by Windows installer or by unzipping it anywhere on the disk from downloaded ZIP archive.

To use it, you have two options
There are two options running OpenPype

**openpype_gui.exe** is the most common for artists. It runs OpenPype GUI in system tray. From there you can run all the available tools. To use any of the features, OpenPype must be running in the tray.
first most common one by using OP icon on the Desktop triggering
Copy link
Collaborator

Choose a reason for hiding this comment

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

Admittedly this is hard for me to follow...

I have two options to install:

  • Installer
  • Unzipping ZIP archive

I have two options to run, but the added 'first most common one' mention makes it hard to follow because it's not visually connected to the line that it should be connected to.
First off, I think when unzipping the ZIP archive, there won't be an OP icon on the desktop.
Second, I'd refrain from abbreviating OpenPype to OP early on in the getting started guide, just to remain very explicit to the end user.

Copy link
Member Author

Choose a reason for hiding this comment

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

@BigRoy Yeah, you are right, good points! Sry just starting with writing docs being noobish! Thanks for your input will take it on my mind when correcting it!

@LiborBatek LiborBatek marked this pull request as draft January 25, 2023 15:17
@LiborBatek LiborBatek marked this pull request as ready for review January 31, 2023 10:00
@LiborBatek
Copy link
Member Author

Did make propery changes according to @BigRoy comments. Should be fine now.

website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
website/docs/artist_getting_started.md Outdated Show resolved Hide resolved
LiborBatek and others added 8 commits February 1, 2023 10:12
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Co-authored-by: Roy Nieterau <roy_nieterau@hotmail.com>
Copy link
Collaborator

@BigRoy BigRoy 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 - I still think we can improve this situation slightly by having that information either merged here or linking back/forth. Having the screenshots (like at the bottom here) is actually really nice and would be good to maybe move here too?

@LiborBatek
Copy link
Member Author

@BigRoy Good Idea...I have just simply linked the pic from install section of the systray icon and slightly adjusted Note section above...
Thx for all your reviews and ideas!

@mkolar mkolar merged commit fbe4abf into develop Feb 3, 2023
@github-actions github-actions bot added this to the next-patch milestone Feb 3, 2023
@mkolar mkolar deleted the feature/user-docs_adjustments branch February 3, 2023 10:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants