nomad icon indicating copy to clipboard operation
nomad copied to clipboard

DOCS ☂️ Rework high-impact tutorials

Open philrenaud opened this issue 2 years ago • 1 comments

Recently, we've taken a look at some of our tutorials feedback for Nomad and noticed some outliers in terms of helpfulness responses and feedback.

The following tutorials are good candidates for updates or rewrites:

  • [ ] Deploy and Manage Applications
    • currently serves as a book-jacket more than a guide. Candidate for removal in favour of other tutorials?
  • [ ] Set up a Nomad Cluster on AWS
    • "It would be a nice-to-have if this tutorial had a version that only dealt with Nomad."
    • some code outdated (TF should switch to Templatefile use; etc.)
    • server nodes fail on health check / consul errors on startup
    • "Inconsistent dependency lock file" error
    • Destroying and restarting cluster causes errors
    • ami needs to be updated
  • [ ] Set up a Nomad Cluster on Azure
    • Outdated; does not work for Ubuntu versions higher than 16.04
  • [ ] Deploy and Update a Job
    • noted redis ConnectionError from the web app on :5000. Possibly mac specific?
    • "had trouble following along" / "a single docker workflow deployment would be better"
  • [ ] Create a Cluster
    • A lot of the comments indicate "This is just setting it up locally / not a real-world scenario", so maybe the solution here is to have an introduction "choose your own adventure" of "Do you want to create a cluster on your local machine? or on $cloudProvider?"
  • [ ] Enable Gossip Encryption for Nomad
    • nomad operator keygen deprecated, should use `nomad operator gossip keyring generate]
  • [ ] Introduction to Nomad Pack
    • Include make, go, and hclfmt under requirements/deps (and installation instructions?)
    • "The github URL is incorrect. It's missing the ".git" at the end."

philrenaud avatar Dec 05 '23 15:12 philrenaud

I moved the corresponding Jira task to the Runtime Education project and let Jeff know.

aimeeu avatar Aug 15 '24 18:08 aimeeu

Closing in prep for docs migration to mono repo.

aimeeu avatar Oct 31 '25 16:10 aimeeu