Skip to content

Commit

Permalink
requested changes and edits to README Posting...
Browse files Browse the repository at this point in the history
  • Loading branch information
ioduok committed Nov 13, 2024
1 parent e1ac1b7 commit 18e2c66
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/enforcer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: 'Check Branch'
on:
pull_request:
branches:
- base
- gh-pages

jobs:
check_branch:
Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
name: Test

on:

pull_request:

branches:

- development

jobs:
Expand Down
18 changes: 0 additions & 18 deletions .travis.yml

This file was deleted.

9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,19 @@ excerpt_separator: <!--more-->
## Posting on Bits & Bytes

### Create a new branch
Create a new GitHub branch from the `gh-pages` branch. This is so we can track any changes and associate them with specific pull requests. You should name your branch `YYYY-MM-DD-post`. See the GitHub documentation on [creating new branches](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository) if you have questions.
Create a new GitHub branch from the `development` branch. This is so we can track any changes and associate them with specific pull requests. You should name your branch `YYYY-MM-DD-post`. See the GitHub documentation on [creating new branches](https://help.github.com/en/articles/creating-and-deleting-branches-within-your-repository) if you have questions.

### Push your files to the new branch
Place your files in the correct locations in your new branch (see "[Post name and location](#post-name-and-location)" section above).

### Create a pull request
Once you have created a branch and placed your post file and images in the correct location you can open a pull request. You should create a pull request from your newly created branch which points at the `gh-pages` branch. See the GitHub documentation on [creating pull requests](https://help.github.com/en/articles/creating-a-pull-request) if you have questions. Request review from another RAC staff member in the pull request.
Once you have created a branch and placed your post file and images in the correct location you can open a pull request. You should create a pull request from your newly created branch which points at the `development` branch. See the GitHub documentation on [creating pull requests](https://help.github.com/en/articles/creating-a-pull-request) if you have questions. Request review from another RAC staff member in the pull request.

### Merge the pull request
Once another RAC staff member has reviewed and approved your pull request, you are ready to merge that pull request into the `gh-pages` branch. This will automatically publish the post, so only merge when you are ready for your post to be visible to the world. See the GitHub documentation on [merging pull requests](https://help.github.com/en/articles/merging-a-pull-request) if you have questions.
Once another RAC staff member has reviewed and approved your pull request, you are ready to merge that pull request into the `development` branch. See the GitHub documentation on [merging pull requests](https://help.github.com/en/articles/merging-a-pull-request) if you have questions.

### Create a pull request and merge to gh-pages branch
Follow the steps outlined above to create a pull request from the `development` branch that points to the base branch, `gh-pages`. Then, merge that pull request into the `gh-pages` branch. This will automatically publish the post, so only merge when you are ready for your post to be visible to the world. By pushing your post to the `development` branch first, you are able to preview the text before it is published to the website.

### Creating tables
In order for [Markdown tables](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables) to render properly, they need to be separated from other block-level elements. This means you should add a blank line before and after a table in order for it to render properly.
Expand Down

0 comments on commit 18e2c66

Please sign in to comment.