Skip to content
This repository has been archived by the owner on Apr 5, 2023. It is now read-only.

Doc Setup Recommendations #1

Open
starryeyez024 opened this issue Feb 15, 2017 · 2 comments
Open

Doc Setup Recommendations #1

starryeyez024 opened this issue Feb 15, 2017 · 2 comments

Comments

@starryeyez024
Copy link

starryeyez024 commented Feb 15, 2017

These are great! Here's some suggestions to amp up the docs a bit:

  1. In addition to the readme instructions like
    DRUPAL_LOC="<path to drupal install on sandboxes"
    it's always helpful to see actual examples like
    DRUPAL_LOC="/usr/share/foo/html"
  2. Some step by step recommendations on where to install these scripts, and even where .bash_profile lives might be good, like:
    • in your user directory, run git clone [email protected]:casnroberts/bash-helper-scripts.git
    • in your user directory, open up .bash_profile in an IDE. If you can't see this file.. here's how to show invisible files.
    • in the .bash_Profile on the line that loads these scripts, should that path be relative to the bash_profile file? should it start with a forward slash?
    • maybe include a silly function like alias king='say -v Cellos -r 300 "la la la la laaaaa la laaaaa la la la lalalala laaaara la la la la"' that they can test running something at the end of setup, to know if everything works correctly
  3. I'm not sure what the load order of all the scripts are, like for example if i want to create an alias called banana-foo that calls pksync, where should that live? In the .bash_profile directly, underneath the line that loads the other functions?
@starryeyez024
Copy link
Author

starryeyez024 commented Feb 15, 2017

  1. It also might be worth adding a note about pksync, like
  • should you run it in the webrh or webdrupal directory (or does it not matter)
  • can you have grunt watcher running in one window and run pksync in another?
  • do you need to run grunt first? If so, can/should that be rolled into this command?

@castastrophe
Copy link
Owner

Great feedback! For #4, bullet 3, it compiles by running grunt as part of the pksync command but good point about not running pksync at the same time as grunt watcher.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants