cdp-ucsc / doc

0 stars 0 forks source link

Onboarding docs Improvements #33

Closed tgraham-ucsc closed 1 year ago

tgraham-ucsc commented 1 year ago

Feeback from the onboarding docs:

Account requests

- link to vpn-dc account request (or instructions on how to get there)

- To avoid vague requests to data-services@ucsc.edu, display list of security roles to include in the request for each system (e.g. data analyst, data engineer, view-only)

* The SSO links work without having accounts in the target systems, which can land the user in places like 
https://cloud.ucsc.getdbt.com/ which displays a menu with greyed-out items and "loading" icons. Maybe add some verbiage to explain that sign-on may _seem_ to work but this doesn't mean you have an account

* #cdp-analytics-engineering doesn't show up on my Slack channel browser, so couldn't join (the other two were accessible).

Workstation Setup

* for "Installation instructions: openssl, readline, sqlite3, xz, zlib", maybe include the "brew update" command before homebrew usage

* minor errors popped up but resolvable by following the homebrew instructions:

    ==> Installing python@3.9
    ==> Pouring python@3.9--3.9.17.monterey.bottle.1.tar.gz
    Error: The `brew link` step did not complete successfully
    The formula built, but is not symlinked into /usr/local
    Could not symlink bin/2to3-3.9
    Target /usr/local/bin/2to3-3.9
    already exists. You may want to remove it:
      rm '/usr/local/bin/2to3-3.9'

    To force the link and overwrite all conflicting files:
      brew link --overwrite python@3.9

    To list all files that would be deleted:
      brew link --overwrite --dry-run python@3.9

    [...]

    ==> Pouring python@3.11--3.11.4.monterey.bottle.1.tar.gz
    Error: The `brew link` step did not complete successfully
    The formula built, but is not symlinked into /usr/local
    Could not symlink bin/2to3
    Target /usr/local/bin/2to3
    already exists. You may want to remove it:
      rm '/usr/local/bin/2to3'

    To force the link and overwrite all conflicting files:
      brew link --overwrite python@3.11

    To list all files that would be deleted:
      brew link --overwrite --dry-run python@3.11

Install Python using pyenv

* In instructions on running the install through VSCode, add a brief instruction to create new file/window and select View > Terminal

* Updating $PATH: add an "echo $PATH" statement to verify

* pyenv versions command returns the following (assuming it's ok; it's actually helpful to see the .pyenv directory path)
    * system (set by /Users/psbauman/.pyenv/version)
      3.9.13

    * I did switch to 3.9.13

* we typically use .bash_profile for PATH, so I added the eval "$(pyenv init --path)" there

* you can load .bashrc into session without closing window with:
> . ~/.bashrc