Skip to content

Contrib tutorial#1363

Merged
carolynvs merged 5 commits intogetporter:mainfrom
carolynvs:contrib-tutorial
Nov 18, 2020
Merged

Contrib tutorial#1363
carolynvs merged 5 commits intogetporter:mainfrom
carolynvs:contrib-tutorial

Conversation

@carolynvs
Copy link
Copy Markdown
Member

@carolynvs carolynvs commented Nov 12, 2020

What does this change

  • Add a tutorial for new contributors that walks through how to modify, build and test porter.
  • Add the contributing guide to the website and link to the tutorial.

https://deploy-preview-1363--porter.netlify.app/contribute/guide/ (links to tutorial now)
https://deploy-preview-1363--porter.netlify.app/contribute/tutorial/

What issue does it fix

N/A

Notes for the reviewer

Relies on #1362 because it removes a blocking issue for upgrading hugo to 0.78.1

Checklist

  • Unit Tests
  • Documentation
  • Schema (porter.yaml)

@carolynvs carolynvs marked this pull request as ready for review November 12, 2020 21:29
@carolynvs carolynvs force-pushed the contrib-tutorial branch 2 times, most recently from aee1516 to 612ec75 Compare November 13, 2020 14:47
@carolynvs carolynvs requested a review from iennae November 13, 2020 15:18
Copy link
Copy Markdown
Member

@vdice vdice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Perhaps worth double-checking a few links...

Comment thread docs/content/contribute/tutorial.md Outdated
Comment thread docs/content/contribute/guide.md
* Hugo 0.78.1 lets us use {{ toc }} to embed a table of contents
* Add docs/content/sources to symlink files outside of docs/content to
  include them in the site, such as CONTRIBUTING.md
* Consolidate under /contribute so that all related pages for
  contributing are under that directory.
* Add a tutorial for new contributors that walks through how to modify, build and test porter.
* Add the contirbuting guide to the website and link to the tutorial.

Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
* Fix github md links so they work when used in Hugo
* Link to gh org when mentioning our many repos

Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
* Add DCO to the tutorial
* Add fork setup to the tutorial
* Link to tutorial from contributing
* Remove double link to /contribute in nav

Signed-off-by: Carolyn Van Slyck <me@carolynvanslyck.com>
@carolynvs carolynvs merged commit d64b09d into getporter:main Nov 18, 2020
@carolynvs carolynvs deleted the contrib-tutorial branch November 18, 2020 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants