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

Doc Setup Recommendations #1

@starryeyez024

Description

@starryeyez024

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 git@github.com: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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions