Skip to content

Commit

Permalink
Merge pull request linode#6864 from crystallearobertson/rc-v1.308.0
Browse files Browse the repository at this point in the history
[Release Candidate] v1.308.0
  • Loading branch information
crystallearobertson authored Mar 5, 2024
2 parents ab017a3 + bc12fd5 commit 0890745
Show file tree
Hide file tree
Showing 22 changed files with 1,143 additions and 24 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/incorrect-information-code.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Incorrect information or code
description: File a report on incorrect information or code
title: "[Incorrect information/code]: "
labels: ["incorrect info", "triage"]
body:
- type: markdown
attributes:
value: |
Thank you for filing this report!
- type: textarea
id: context
attributes:
label: Relevant Context
render: shell
- type: input
id: file
attributes:
label: The Source File
validations:
required: false
- type: textarea
id: issue-description
attributes:
label: Description of incorrect information/code
description: Which information or code needs to be corrected?
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: proposed-fix
attributes:
label: Your proposed fix for the incorrect information/code (optional)
description: How should the incorrect information/code be fixed?
placeholder: Your proposed fix
value: ""
validations:
required: false
- type: input
id: contact
attributes:
label: Contact Details
description: How can we get in touch with you if we need more info?
placeholder: ex. email@example.com
validations:
required: false
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
options:
- label: I agree to follow this project's Code of Conduct
required: true
46 changes: 31 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,21 +125,21 @@ While macOS and Linux are preferred by most of the core Linode Docs team, it's a

## Fork and Clone the Linode Library

All of our guides are stored in the [github.com/linode/docs](https://github.com/linode/docs) repository. You will need to clone this repository to your local computer.
All of our guides are stored in the [github.com/linode/docs](https://github.com/linode/docs) repository. You will need to fork this repository and clone your fork to your local computer.

For more information about using Git, refer to the [official Git documentation](https://git-scm.com/documentation). If you're a Git beginner, both [GitHub](https://guides.github.com/) and [GitLab](https://docs.gitlab.com/ee/gitlab-basics/README.html) offer excellent primers to get you started.

1. On Github, navigate to the [linode/docs](https://github.com/linode/docs) repository. Click fork on the top right corner.
1. On Github, navigate to the [linode/docs](https://github.com/linode/docs) repository. Click fork on the top right corner. When creating your fork, you only need to copy the develop branch.

1. Clone your fork of the repository using either the [HTTPS URL](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls) or the [SSH URL](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-ssh-urls). In the commands below, replace `USERNAME` with your GitHub username.
1. Clone your fork of the repository using either the [SSH URL](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-ssh-urls) or the [HTTPS URL](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls). In whichever command you run below, replace `USERNAME` with your GitHub username. Running either command creates a `linode-docs` directory in your terminal's working directory.

- **HTTPS URL:** When prompted for your password, enter your personal access token from GitHub. For instructions on creating this token, see [Creating a Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-fine-grained-personal-access-token).
- **SSH URL** (the preferred method): This requires that you have a public/private key pair installed on your local system. If you do not have one, [create one now](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#generating-a-new-ssh-key). Once you have a key pair, upload the public key to your GitHub account. For further instructions, see [Adding a new SSH key to your account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). When running the command below, you will be prompted for a password. Enter your SSH passphrase in this prompt.

git clone https://github.com/USERNAME/docs linode-docs
git clone git@github.com:USERNAME/docs.git linode-docs

- **SSH URLs:** Before continuing with SSH URLs, you should first have a public/private key pair installed on your local system. Then, you must upload your public key to your GitHub account. When running the command below, you will be prompted for a password. Enter your SSH passphrase in this prompt. For further instructions, [Adding a new SSH key to your account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).
- **HTTPS URL:** When prompted for your password, enter your personal access token from GitHub. For instructions on creating this token, see [Creating a Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#creating-a-fine-grained-personal-access-token).

git clone git@github.com:USERNAME/docs.git linode-docs
git clone https://github.com/USERNAME/docs linode-docs

This may take a few minutes to copy all of the files and images to your machine.

Expand All @@ -160,8 +160,21 @@ For more information about using Git, refer to the [official Git documentation](

1. Add the `linode/docs` repository that you forked from as the `upstream` [Git remote](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) for your local repository:

- **HTTPS URL:** `git remote add upstream https://github.com/linode/docs.git`
- **SSH URL:** `git remote add upstream git@github.com:linode/docs.git`
- **HTTPS URL:** `git remote add upstream https://github.com/linode/docs.git`

1. View your remote repositories by running:

git remote -v

This command outputs all remote repositories and should match the following.

origin git@github.com:USERNAME/docs.git (fetch)
origin git@github.com:USERNAME/docs.git (push)
upstream git@github.com:linode/docs.git (fetch)
upstream git@github.com:linode/docs.git (push)

Most importantly, the origin should be your fork and the upstream should be the `linode/docs` repository. If you cloned the repository (or added the `upstream` remote) using the HTTPS URLS, the output will use those URLs instead.

1. Install the Node dependencies for the repository:

Expand Down Expand Up @@ -256,20 +269,23 @@ This section takes you through the process of creating a new guide, using the to

## Write and Submit

Your local Hugo development server has hot-reloading enabled, so you will be able to view changes to your guide as you save them. Please see our [Linode Writer's Formatting guide](https://www.linode.com/docs/linode-writers-formatting-guide/) for more information.
1. Make edits or write new content using any text editor, though we recommend a code editor like [Visual Studio Code](https://code.visualstudio.com/). Your local Hugo development server has live preview functionality, so you will be able to view changes to your guide as you save them. Review our [Linode Writer's Formatting guide](https://www.linode.com/docs/linode-writers-formatting-guide/) for more information on how to make edits and for formatting / style guidelines.

Any images that you include in the guide should be added inside the same directory as the new `index.md` file. Images should be linked to using their filename as the relative URL: `![Image Title](image.png)`.
Any images that you include in the guide should be added inside the same directory as the new `index.md` file. Images should be linked to using their filename as the relative URL: `![Image Title](image.png)`. See the [Images](https://www.linode.com/docs/guides/linode-writers-formatting-guide/#images) section of the writer's formatting guide.

1. Commit your changes to your local branch:
1. Stage your changes to your local branch. As a best practice, use a command like `git status` to verify you're working out of the correct branch and view a list of files that have been changed. If the output shows only the files that you've explicitly edited, you can stage them all at once using `git add .` Otherwise, add each one individually by referencing the file path in that command.

git add docs/guides/web-servers/nginx/how-to-install-nginx-on-debian/

1. Once the changes are staged, commit them using the command below. Your commit message should summarize the changes that were made.

git commit -m "Initial draft of guide"

1. Push the local branch to your fork:
1. Push the local branch to your remote fork (the `origin` remote repository).

git push --set-upstream origin nginx-on-debian
git push origin nginx-on-debian

1. Go to `https://github.com/linode/docs` and open a pull request.
1. In your web browser, you can now navigate to `https://github.com/linode/docs` and open a pull request. When creating a pull request, provide a detailed overview of the changes.

Your guide is now submitted. Thank you for contributing to Linode! A member of the content team will review your guide and contact you if any changes are required.

Expand All @@ -285,4 +301,4 @@ In the Travis CI overview, under the **Jobs and Stages** header, three tests are

- Docs404: A custom script that scrapes the site and reports any internal 404 links. This script does not currently check for external 404 links.

To review the output of a given test, click on the link for the corresponding Travis CI job.
To review the output of a given test, click on the link for the corresponding Travis CI job.
7 changes: 7 additions & 0 deletions ci/vale/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,7 @@ Freemarker
freenom
fremont
freshclam
freshdesk
friendica
friendster
frontend
Expand Down Expand Up @@ -785,6 +786,7 @@ getpwent
getters
getty
getuid
geventhttpclient
gfx
gfxmode
gianlucaborello
Expand Down Expand Up @@ -1250,6 +1252,8 @@ localdomain
localhost
localuser
lockdown
locustfile
locustfiles
lodash
logallrefupdates
logdir
Expand Down Expand Up @@ -1611,6 +1615,7 @@ OKConfig
okta
oldstable
oldfashioned
omnichannel
onboarding
oneof
ons
Expand Down Expand Up @@ -2141,6 +2146,7 @@ smtpd
smush
smux
snakeoil
snapcraft
snapd
snipcart
snmp
Expand Down Expand Up @@ -2701,6 +2707,7 @@ zabbix
zapier
zcat
zend
zendesk
zgrep
zhao
zigbee
Expand Down
Loading

0 comments on commit 0890745

Please sign in to comment.