Skip to content

Commit

Permalink
Merge pull request #1263 from FlowFuse/eng-section-update
Browse files Browse the repository at this point in the history
Update engineering section with more details on ops
  • Loading branch information
knolleary authored Oct 19, 2023
2 parents eb2cf50 + 73b8206 commit 9437269
Show file tree
Hide file tree
Showing 20 changed files with 213 additions and 507 deletions.
2 changes: 1 addition & 1 deletion src/handbook/design/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
navTitle: Design
navGroup: Development & Design Practices
navGroup: Engineering & Design Practices
---

# Design
Expand Down
2 changes: 1 addition & 1 deletion src/handbook/development/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Take your time when committing files. Review each file carefully and ensure what

#### Branching vs. Forking

Commits should never be pushed directly to `main`. Instead, branch or fork from the relevant branch (most likely `main`) and work from there.
Commits must never be pushed directly to `main`. Instead, branch or fork from the relevant branch (most likely `main`) and work from there.

It is preferred that new work be added on a branch (rather than in a forked repository), although this is not enforced. Branch names should be short, informative, and if directly linked to a single issue number, reference such issue number, e.g. `29-issue-summary`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,13 @@ The first step to editing content is to create a [Branch](#branch) of that conte

Navigate to the Project within [Github](#github) you want to work on, that would usually be [our website](https://github.com/FlowFuse/website) or [Handbook](https://github.com/FlowFuse/handbook).

![Create a new Branch](../images/git-how-to/new-branch-1.png)
![Create a new Branch](../../images/git-how-to/new-branch-1.png)

The [Branch](#branch) name should give a brief overview of what you are planning to change in the [Project](#project), for example ‘Add Git guide for non-tech projects & staff’ then click the ‘create branch’ link.

You should now notice that where the drop down said ‘main’ before it now says the name of the [Branch](#branch) you just created.

![Create a new Branch](../images/git-how-to/new-branch-2.png)
![Create a new Branch](../../images/git-how-to/new-branch-2.png)

You can now start the process of actually creating or editing content, any changes you make will not yet be added to the [Published](#publish) version of the [Live](#live) [Project](#project) so don't worry if you make mistakes or are not yet happy with the finished product.

Expand All @@ -78,7 +78,7 @@ In this example I am going to create a new document in the [Handbook](#handbook)

Firstly I will create a new document called git-how-to.md in the design folder.

![Create a new file](../images/git-how-to/new-file-1.gif "@skip")
![Create a new file](../../images/git-how-to/new-file-1.gif "@skip")

The file type is .md (Markdown). A [Markdown](#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](#markdown) here.

Expand All @@ -88,7 +88,7 @@ In the video above I pressed ‘[Commit](#commit) changes’ which is the same a

I can now start the process of writing my document, first I will reopen it in the editor, then I will add the content.

![Edit the new file](../images/git-how-to/edit-file-1.gif "@skip")
![Edit the new file](../../images/git-how-to/edit-file-1.gif "@skip")

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](#commit) the changes as I did before.

Expand All @@ -100,13 +100,13 @@ I am now ready to request a [Review](#review) of my work from a colleague. To do

[Github](#github) gives you an easy to find button to create a [Pull Request](#pull-request) for your current work.

![Create a Pull Request](../images/git-how-to/create-a-pr-1.gif "@skip")
![Create a Pull Request](../../images/git-how-to/create-a-pr-1.gif "@skip")

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](#review) your work.

Once you press the 'Create pull request' button an alert will be sent to one of FlowFuse's Slack channels letting everyone know you'd like your work reviewed. You can also request a [review](#review) from a specific colleague using the [Reviewers](#reviewer) section of your [Pull Request](#pull-request) Click on [Reviewers](#reviewer) then select the colleague you think would be best placed to [review](#review) your work.

![Request a review from a specific colleague](../images/git-how-to/nominate-a-reviewer-1.gif "@skip")
![Request a review from a specific colleague](../../images/git-how-to/nominate-a-reviewer-1.gif "@skip")

### Requesting a review of your work

Expand Down
11 changes: 11 additions & 0 deletions src/handbook/development/guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
navTitle: Guides
---

# Guides

A collection of guides for some of things that are foundational to working at
FlowFuse

- [Git Intro](./git.md) - get started with Git
- [Markdown Guide](./markdown.md) - a quick primer for Markdown
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
navTitle: Markdown How-To
navTitle: Markdown Guide
---

# Markdown How-To
# Markdown Guide

This is a very short reference guide for those trying to write Markdown. For more
comprehensive guides, we recommend looking at:
Expand Down Expand Up @@ -76,10 +76,10 @@ from the previous paragraph.

## Links

[this will be a link](http://localhost:8080/blog/2023/02/flowforge-1-4-0-released/)
[this will be a link](http://example.com/)

```md
[this will be a link](http://localhost:8080/blog/2023/02/flowforge-1-4-0-released/)
[this will be a link](http://example.com/)
```

## Images
Expand Down
49 changes: 0 additions & 49 deletions src/handbook/development/how-we-work/contributing.md

This file was deleted.

14 changes: 0 additions & 14 deletions src/handbook/development/how-we-work/index.md

This file was deleted.

186 changes: 0 additions & 186 deletions src/handbook/development/how-we-work/packaging.md

This file was deleted.

Loading

0 comments on commit 9437269

Please sign in to comment.