-
-
Notifications
You must be signed in to change notification settings - Fork 777
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
Update ReadMe to add instructions for new team members beyond dev environment. #158
Comments
@harishlingam I had started this issue to track the change I had made to the readme. |
website
This is a standard Jekyll site hosted right here on GitHub pages. There are two options for developing the site locally: (1) Using the environment container "Docker" or (2) using Ruby and Jekyll directly ensuring you're using the same exact environment we're developing in. Therefore the first approach is recommended and very easy to use. The second approach is not supported. First you'll need the repository on your computer so you have a site to run when these development environments are installed. Developing via DockerThis is the recommended approach to quickly getting started. There are two pre-requisites: Docker and Docker Compose. More on using Docker and the concepts of containerization: Build and serve the website locallyThis command starts a jekyll server locally. The server watches for changes to docker-compose up Now browse to http://localhost:4000 Tear downTo stop and completely remove the jekyll server (i.e. the running Docker container): (do this anytime Docker or jekyll configuration or other repository settings change) docker-compose down To stop the server, but not destroy it (often sufficient for day-to-day work): docker-compose stop Bring the same server back up later with: docker-compose up Git:Forking and Cloning the Repository with Proper SecurityStep 1: Get added as a member of the GitHub repositoryIn the hfla-website slack channel, send your GitHub name to the project manager (or on the slack channel thread) and we'll add you as a member to the GitHub repository. Once you have accepted github invite (comes via email or in your GitHub.com inbox), please do the following: Mark your own membership public Setup two factor authentication on your account Step 2: Fork the RepositoryIn https://github.com/hackforla/website, look for the fork icon in the top right. Click it and create a fork of the repository. Step 3: Clone YOUR online repository to your local computerFor git beginners, this process will create a third copy of the repository on your local desktop. First create a new folder on your desktop that will contain hackforla projects. git clone https://github.com/your_GitHub_user_name/website.git You should now have a new folder in your hackforla folder called "website". If you accidentally cloned the hackforla/website.git then you can change your local copy to upload to YOUR fork by the following: git remote set-url origin https://github.com/your_user_name/website.git This will check if which URL you're pointing to: git remote show origin Step 4: Change to a new branchFor each issue, we'll try to create a new branch for that issue. git branch By default you should start on the 'gh-pages' branch. git checkout -b 140-fix-logo-width We prefer that you work on a branch name that relates to the issue you're working on (or assigned). Incorporating changes from upstreamYour fork of this repository on GitHub, and your local clone of that fork, will A few # WARNING: this will erase local pending changes!
# commit them to a different branch or use git stash
git checkout gh-pages
git fetch upstream
git reset --hard upstream/gh-pages Creating a new branch for feature/bugfix work now results in a clean, easy merge Now that local is up to date with git push --force origin/gh-pages Making changes, committing and pushingThe general process of making changes to the website is to make changes on your local repository of your fork in your own branch. Then commit those changes with a comment related to the issue it addresses to your local repository. Then push that commit to YOUR online fork. Then go to the hackforla repository and create a PULL request which asks hackforla to pull changes from YOUR fork into their repository. Therefore all changes are made on your copy and only after the owner of the hackforla website approves and pulls your changes will updates be made. New git users: please ask around for guidance here. See the commit and push commands. |
I feel that using GitHub Desktop is much easier than command line Git for new users. I've been using it for a class project and it's worked out well. It helps with branches and rebasing (though instructions would be helpful there anyway). |
@thekaveman @alecg123 @sarL3y @KianBadie @ExperimentsInHonesty @harishlingam this seems to be an easier approach to drafting an update to the readme than pushing changing and having Kegan review it. |
Overview
Does the working READme file easily on-board new team members?
Action Items
Resources/Instructions
PUT LINK TO README.md FILE HERE:
https://drive.google.com/file/d/1eiUvGItwhdtzB0SccNP9DP78FrVM8wUx/view?usp=sharing
The text was updated successfully, but these errors were encountered: