-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Initial Deployment Docs #9
Initial Deployment Docs #9
Conversation
@tsande16 and @cshannon2 This would be a starting baseline condensing of the pre-existing information in the category. eclipse-pass/main#1008 subtracts the docs that feed into this one, or are obsolete in general. |
@steven-exarcos this looks like a good first start! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Content looks really good. Only 1 small suggestion.
We've been using the following layout for our "flow" from the style guide: https://docs.google.com/document/d/11aCooQCNhEq34yG9mGuFynY4xMDRJtPRuOOou9LaCgU/edit?usp=sharing
Topic
Topic Summary
Knowledge Needed / Skills Inventory
Technologies Utilized
Technical Deep Dive
Next Step / Institution Configuration
Related Information
Although after reading this, it seems that the deployment guide could follow a different layout/structure. For now, I think this is a good flow and Chris and I can discuss later.
@tsande16 I renamed the sections to match the style guide where it made sense. I agree that for the middle technical sections, Knowledge Needed / Skills Inventory, Technologies Utilized, Technical Deep Dive, Next Step / Institution Configuration, they dont fit as smoothly when describing a process versus a spec. Also -- since I'm a new in eclipse org, I dont have permissions to merge yet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noticed one more thing. Looks like there is an added code block at the end of the files for the CI/CD and README?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like with the change of header names it broke some links.
A document covering the
infrastructure-documenation/deployment
topic superseding the legacy docs in https://github.com/eclipse-pass/main/tree/main/docs/infra.