- Development & Design Practices
- Front End
- How We Work
- Using Git
- Internal Operations
- People Ops
- Sales & Marketing
# How to use Git (for non-developer team members)
Git is a way for a team to create written content, track any changes to that content, and seek approval for any changes to become the Published version of that content on Live. Git can be used in many ways, our developers use it to write the code which makes FlowForge work. In this guide we are focusing on the process of working with documents within our company Handbook or website. We will use Git's terminology to describe how we are working. This guide also assumes you are using Github.com to edit the Handbook and website.
# How to make changes to the Live version of a Project
# Create a Branch
The first step to editing content is to create a Branch of that content. A Branch is a complete copy of the Project. Creating a Branch allows you to edit the content without those edits changing the Live copy of a Project.
You should now notice that where the drop down said ‘main’ before it now says the name of the Branch you just created.
You can now start the process of actually creating or editing content, any changes you make will not yet be added to the Published version of the Live Project so don't worry if you make mistakes or are not yet happy with the finished product.
# Create a new file (document)
Firstly I will create a new document called git-how-to.md in the design folder.
The file type is .md (Markdown). A Markdown file is similar to a .docx or .txt. It allows you to lay out content in a document including text, images, titles, headers and tables. You can read more about Markdown here.
In the video above I pressed ‘Commit changes’ which is the same as saving your document.
# Editing your document
I can now start the process of writing my document, first I will reopen it in the editor, then I will add the content.
I will work on the file until I think it's ready for a colleague to review the changes I have made. Once I am happy with the content I will Commit the changes as I did before.
# How to get those changes published
# Creating a Pull Request
I am now ready to request a Review of my work from a colleague. To do this I need to create a Pull Request. Once you create the Pull Request an alert will be sent to your colleagues asking them for feedback on your work.
It's a good idea to provide your colleagues descriptive comments explaining the goals of the changes you have made as well as anything else you think would help them review your work.
Once you press the 'Create pull request' button an alert will be sent to one of FlowForge's Slack channels letting everyone know you'd like your work reviewed. You can also request a review from a specific colleague using the Reviewers section of your Pull Request Click on Reviewers then select the colleague you think would be best placed to review your work.
# Requesting a review of your work
# Approval of your Branch to go live
# Comments on your Branch asking you to make edits.
Once you are happy that your edits address the Reviewer's feedback points Commit your changes. You should now also reply to each of the Reviewer's comments letting them know what you changed or why you didn't change anything based on their comments.
The Reviewer will now read your comments and edits and based on their actions you may need to respond to further comments or edits.
# Suggested edits to your Branch.
TO DO - How does the user actually deal with this?
# Publishing to live
TO DO - Write up the process to publish to live.
An app to help us collaboratively manage changes to documents. You can read more here but we'd advise you don't unless you are a developer as Git has a lot of features and terminology which you don't need to understand at this point.
A website which allows you to manage Git. Github also allows you to communicate with your colleagues about changes you are making.
FlowForge's public document explaining how run the company.
A collection of documents and content which usually relate to a specific topic. In this guide we are discussing how to edit two FlowForge Projects, our website and our Handbook.
The action which takes your work on a Project and makes it available on the internet for anyone to view.
A team member who is going to check your work and provide feedback.
The process by which a colleague checks and provides feedback on your work.