The start of some User docs #1577

alecthegeek · 2019-06-25T05:17:48Z

Summary of the Pull Request

Some new user documentation to help users get started with Windows Terminal.

References

References: #1576

Closes #xxx
[ X] CLA signed. If not, go over here and sign the CLA
[ N/A] Tests added/passed
[ X] Requires documentation to be updated
I've discussed this with core contributors already. If not checked, I'm ready to accept this work might be rejected in favor of a different grand plan. Issue number where discussion took place: #

Detailed Description of the Pull Request / Additional comments

New file with some simple end user information added. This will need to grow.

Validation Steps Performed

None at this time

JushBJJ

Include the path file of profiles.json in case users have issues opening .json file extension.
C:\Users\Your_Username\AppData\Local\Packages\WindowsTerminalDev_<some_characters>\RoamingState\profiles.json

JushBJJ · 2019-06-25T08:01:18Z

Though, when gui settings for the terminal comes in, this needs to be changed in the future.

JushBJJ

Add a tip on how to put gifs or background images in the terminal.
Refer to #1528

doc/user-docs/index.md

Co-Authored-By: Michael Niksa <[email protected]>

…-docs

alecthegeek · 2019-06-25T20:24:15Z

Include the path file of profiles.json in case users have issues opening .json file extension.
C:\Users\Your_Username\AppData\Local\Packages\WindowsTerminalDev_<some_characters>\RoamingState\profiles.json

Done

JushBJJ

Include the minimum requirements at ### From the Microsoft Store section or similar.

alecthegeek · 2019-06-26T11:22:17Z

Add a tip on how to put gifs or background images in the terminal.
Refer to #1528

Done

alecthegeek · 2019-06-26T11:23:14Z

Include the minimum requirements at ### From the Microsoft Store section or similar.

Welll I figure that might change, so I've put a note saying "review minimum requirements"

Co-Authored-By: Kayla Cinnamon <[email protected]>

1. Merged in comments from PR 2. Made colour color :-( 3. Other tidy ups

alecthegeek · 2019-07-01T08:49:37Z

I've pretty mush exhausted my current knowledge of Windows Terminal.

Can anyone point me to other sources of information?

cinnamon-msft · 2019-07-01T17:06:33Z

This looks great! For the TODOs, I would recommend either removing them or adding the GitHub issue number they're associated with.

1. Some notes abouet cut and paste -- needs more work 2. Get rid of TODO -- replace with links to issues 3. Add some extra notes about URI for background images

alecthegeek · 2019-07-02T09:33:11Z

Well I think I've addressed all the comments, but GitHub says no. Can't find the outstanding request

doc/user-docs/index.md

JushBJJ · 2019-07-02T17:45:29Z

Sorry if I'm a bit late on this. But should we put in a FAQ file or section too?

cinnamon-msft · 2019-07-08T17:54:57Z

Sorry if I'm a bit late on this. But should we put in a FAQ file or section too?

I'm okay with adding an FAQ, but I'd prefer if we did it in a separate PR 😊

* Start User docs * Fix typos * Addded some more TODO * Update doc/user-docs/index.md Co-Authored-By: Michael Niksa <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Michael Niksa <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Michael Niksa <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Michael Niksa <[email protected]> * Updated from suggestions in the PR * Improve path to profiles.json * Added some details about Json settings * Example Json settings, and a #TODO * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/UsingJsonSettings.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * Update doc/user-docs/index.md Co-Authored-By: Kayla Cinnamon <[email protected]> * After review and make colour US. 1. Merged in comments from PR 2. Made colour color :-( 3. Other tidy ups * Added more detais about background images * Remove some TODO comments and minot tidy up * Get rid of TODO 1. Some notes abouet cut and paste -- needs more work 2. Get rid of TODO -- replace with links to issues 3. Add some extra notes about URI for background images

alecthegeek added 2 commits June 25, 2019 14:45

Start User docs

aadcadd

Fix typos

ab28ebd

alecthegeek changed the title ~~The starr of some User docs~~ The start of some User docs Jun 25, 2019

Addded some more TODO

c503546

JushBJJ suggested changes Jun 25, 2019

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jun 25, 2019

JushBJJ suggested changes Jun 25, 2019

View reviewed changes

carlos-zamora requested a review from cinnamon-msft June 25, 2019 16:25

miniksa reviewed Jun 25, 2019

View reviewed changes

doc/user-docs/index.md Outdated Show resolved Hide resolved

miniksa reviewed Jun 25, 2019

View reviewed changes

doc/user-docs/index.md Outdated Show resolved Hide resolved

miniksa reviewed Jun 25, 2019

View reviewed changes

doc/user-docs/index.md Outdated Show resolved Hide resolved

miniksa reviewed Jun 25, 2019

View reviewed changes

doc/user-docs/index.md Outdated Show resolved Hide resolved

Update doc/user-docs/index.md

316aa41

Co-Authored-By: Michael Niksa <[email protected]>

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jun 25, 2019

alecthegeek and others added 6 commits June 26, 2019 06:09

Update doc/user-docs/index.md

9f84ed9

Co-Authored-By: Michael Niksa <[email protected]>

Update doc/user-docs/index.md

41ef3d3

Co-Authored-By: Michael Niksa <[email protected]>

Update doc/user-docs/index.md

415ba7e

Co-Authored-By: Michael Niksa <[email protected]>

Updated from suggestions in the PR

7160ab0

Merge branch 'master' of github.com:microsoft/terminal into user-docs

da9dcae

Merge branch 'user-docs' of github.com:alecthegeek/terminal into user…

c46fcde

…-docs

Improve path to profiles.json

e94a1ba

JushBJJ suggested changes Jun 25, 2019

View reviewed changes

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jun 25, 2019

Added some details about Json settings

d169eb8

ghost removed the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jun 26, 2019

Example Json settings, and a #TODO

802c1db

alecthegeek and others added 12 commits July 1, 2019 18:33

Update doc/user-docs/UsingJsonSettings.md

0041ccd

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/UsingJsonSettings.md

0ad4986

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/UsingJsonSettings.md

08a72a7

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

de0358c

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

7513bb4

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

1c60012

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

a3151dc

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

4cd2f7e

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

9b063c5

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

9965483

Co-Authored-By: Kayla Cinnamon <[email protected]>

Update doc/user-docs/index.md

a140a6a

Co-Authored-By: Kayla Cinnamon <[email protected]>

After review and make colour US.

85f7b7c

1. Merged in comments from PR 2. Made colour color :-( 3. Other tidy ups

alecthegeek added 2 commits July 1, 2019 20:47

Added more detais about background images

f63c58b

Remove some TODO comments and minot tidy up

fefc024

miniksa approved these changes Jul 1, 2019

View reviewed changes

Get rid of TODO

a107a39

1. Some notes abouet cut and paste -- needs more work 2. Get rid of TODO -- replace with links to issues 3. Add some extra notes about URI for background images

zadjii-msft requested a review from bitcrazed July 2, 2019 13:56

zadjii-msft added the Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs label Jul 2, 2019

cinnamon-msft suggested changes Jul 2, 2019

View reviewed changes

doc/user-docs/index.md Show resolved Hide resolved

ghost added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Jul 2, 2019

bitcrazed mentioned this pull request Jul 2, 2019

Guidance #1774

Closed

cinnamon-msft self-requested a review July 8, 2019 18:16

cinnamon-msft approved these changes Jul 8, 2019

View reviewed changes

cinnamon-msft merged commit c9d8e3e into microsoft:master Jul 8, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The start of some User docs #1577

The start of some User docs #1577

alecthegeek commented Jun 25, 2019

JushBJJ left a comment •

edited

Loading

JushBJJ commented Jun 25, 2019

JushBJJ left a comment

alecthegeek commented Jun 25, 2019

JushBJJ left a comment

alecthegeek commented Jun 26, 2019

alecthegeek commented Jun 26, 2019

alecthegeek commented Jul 1, 2019

cinnamon-msft commented Jul 1, 2019

alecthegeek commented Jul 2, 2019

JushBJJ commented Jul 2, 2019

cinnamon-msft commented Jul 8, 2019

The start of some User docs #1577

The start of some User docs #1577

Conversation

alecthegeek commented Jun 25, 2019

Summary of the Pull Request

References

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

JushBJJ left a comment • edited Loading

Choose a reason for hiding this comment

JushBJJ commented Jun 25, 2019

JushBJJ left a comment

Choose a reason for hiding this comment

alecthegeek commented Jun 25, 2019

JushBJJ left a comment

Choose a reason for hiding this comment

alecthegeek commented Jun 26, 2019

alecthegeek commented Jun 26, 2019

alecthegeek commented Jul 1, 2019

cinnamon-msft commented Jul 1, 2019

alecthegeek commented Jul 2, 2019

JushBJJ commented Jul 2, 2019

cinnamon-msft commented Jul 8, 2019

JushBJJ left a comment •

edited

Loading