Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

System Administrator Documentation #4639

Open
SunSparc opened this issue Apr 27, 2023 · 2 comments
Open

System Administrator Documentation #4639

SunSparc opened this issue Apr 27, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@SunSparc
Copy link
Contributor

Is your feature request related to a problem? Please describe.
The current documentation is targeted to developers. Which leaves system administrators to extrapolate installation methods that will work in an automated fashion.

Describe the solution you'd like
I would like to see some documentation that is directed toward those who install and maintain the Nomad/Waypoint servers.

Specifically I would love to see some best practice installation documentation for setting up Waypoint servers in an automated fashion (infrastructure as code) into a Terraform/Nomad environment.

Explain any additional use-cases
If Waypoint is ONLY for developers, then system administrator documentation does not make sense. However, if you want to gain the support of system administrators, thus increasing adoption of your product, please consider creating documentation that takes the system administrators perspective into account.

Not all organizations have full stack development. Many organizations have developers in one department and operations in another department. The developers focus on developing products, the operations team focuses on maintaining the infrastructure so that the developers do not have to worry about CI/CD. From the developer perspective, the infrastructure should just work. The Waypoint documentations looks great for small teams that manage the entire stack. I do not work in that organization.

Additional context
Is Waypoint not appropriate for medium to large organizations? If that is the case, you should highlight that fact at the very top of your documentation so that SysOps, like myself, do not waste their time trying to incorporate Waypoint into their infrastructure.

@SunSparc SunSparc added the new label Apr 27, 2023
@briancain briancain added documentation Improvements or additions to documentation enhancement New feature or request and removed new labels May 3, 2023
@briancain
Copy link
Member

Hey there @SunSparc - We do have some existing docs on how to run and maintain the open source server: https://developer.hashicorp.com/waypoint/docs/server/run

If there's something there that you wish was covered, feel free to open specific issues or contribute something! Thanks!

@SunSparc
Copy link
Contributor Author

SunSparc commented May 9, 2023

@briancain, yes, I have read through that documentation several times. With that in mind, would you consider the job specification posted at the following URL to be employing your best practices?

Automating the installation of Waypoint with Nomad/Terraform

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants