Contributing

This guide covers the ways to contribute to this site and walks you through a simple edit.

Overview

There are three ways to edit this site:

  1. Edit on Forestry. This option is recommended for non-technical contributors and editors as it is user-friendly.
  2. Edit on GitHub. This option is recommended for those who understand git, GitHub, and the site and are in a hurry (this option is good for quick edits to existing content).
  3. Edit on your computer. This option is recommended for developers, translators, and anyone who wants to edit the mechanics of the site.

Edit on Forestry

Forestry.io is a Content Management System (CMS) that wraps around this repository and allows you to make changes to the site using friendly editors and quick previews before you deploy. Forestry is recommended for non-technical contributors and editors.

Pre-requisites

  1. A GitHub account in the McNeel team (if you are reading this, you should already satisfy this requirement.)
  2. A Forestry account linked to your GitHub account. Ask Dan, Scott, or Brian to invite you to the Forestry.io team.

Try It

Once you can login to Forestry with your GitHub account:

  1. Navigate to your Dashboard, click on the McNeel organization, and find the rhino3d.com site in the list.
  2. The rhino3d.com site on Forestry watches the master branch of this repository. All changes made to the master branch on forestry, on GitHub, on your computer, or on anyone else’s computer will show up on the site.
  3. Click the rhino3d.com site if you have not already done so.
  4. Find the left-hand sidebar and notice that all the major sections of the website are shown here. These sidebar items are shortcuts to the folders in this repository that contain the markdown files used to generate the site. Find the section called Admin and click it.
  5. Find the Contributing file and click it.
  6. You are now editing this guide itself. The editing interface is divided into two parts:
    1. On the left is the “frontmatter.” This is the meta-data about the content itself. The fields will vary by content type, but they will all have a Title and Description.
    2. On the right is the contents of the page itself. This is where the meat of the actual page goes.
  7. In the contents of the contributing page, make a minor change at the bottom. Add <yourname> was here or something noticable.
  8. In the upper right-hand corner, click the Preview (eyeball) button. This launches a new tab with a high-fidelity preview of the page you are editing. You should see your sentence at the bottom (or wherever you put it).
  9. Go back to the editing tab of the Contributing guide. If you were to click the Save button, a commit to master with your change would be pushed to GitHub and the site would be rebuilt and deployed in production (your changes will typically appear within 3 minutes or less).
  10. Remove your edit and Preview the Contributing guide again. This is the next guide you’ll need to follow to get familiar with the conventions and the styles on this website.

That’s it!

Edit on GitHub

Editing on GitHub is perfect for fixing the quick typo.

Pre-requisites

  1. A GitHub account in the McNeel team (if you are reading this, you should already satisfy this requirement.)
  2. Some basic knowledge of git and GitHub (nothing too deep)

Try It

The site content lives in content/en and the folder structure roughly corresponds to the site structure itself. Commits to master will be deployed in production, so be careful. The site is deployed by AWS Amplify and will only deploy if checks pass. Build status displayed in the mcneel slack #build channel. That’s it!

You can also navigate the source for a page from the page itself. If you are logged into https://www.rhino3d.com with your Rhino Account, refresh the page and you should see an Edit this page link near the bottom of the content. Click the Edit on GitHub, make your changes, and commit. The site should deploy with your changes in a matter of minutes.

Edit on your computer

This option is recommended for developers, translators, and anyone who wants to edit the mechanics, or just preview the site locally before committing.

Pre-requisites

  1. A GitHub account in the McNeel team (if you are reading this README, you already satisfy this requirement)
  2. Hugo static site generator.
  3. Visual Studio code
  4. Python

Try It

  1. Clone the repo using your favorite git client or with: git clone https://github.com/mcneel/rhino3d.com.git
  2. Download and install Visual Studio Code.
  3. Open the rhino3d.com folder in Visual Studio Code
  4. The site content lives in content/en and the folder structure roughly corresponds to the site structure itself.
  5. Open content/en/admin/contributing/index.md
  6. Click Hugo: Serve All Languages
  7. Make a minor change at the bottom. Add <yourname> was here or something noticable.
  8. Save the file. Cool. Your browser updated to show you your change.
  9. Revert your change. Commits pushed to master will be deployed in production, so be careful.
  10. Please read the How This Site Works guide as your next step.

That’s it!