Skip to content
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

[WIP] Dev guide #1104

Closed
wants to merge 6 commits into from
Closed

[WIP] Dev guide #1104

wants to merge 6 commits into from

Conversation

Bradamant3
Copy link
Contributor

Current state: content reorg only begun. Not sure it's quite right. Questions for reviewers:

  • there's a sort of gray area between using and extending Ark, especially w/ hooks. Not sure where this should go.
  • ditto plug-ins, although they seem a bit more obviously to belong to a dev guide (or a pointer to the repo, at least)

JENNIFER RONDEAU added 2 commits December 17, 2018 21:12
Signed-off-by: JENNIFER RONDEAU <[email protected]>
Signed-off-by: JENNIFER RONDEAU <[email protected]>
Signed-off-by: JENNIFER RONDEAU <[email protected]>
Signed-off-by: JENNIFER RONDEAU <[email protected]>

For detailed examples, see the YAML files in the [examples directory][6].

TODO FROM JFR: how much introductory/explanatory material should be provided here? This is an audience question. To date, it seems as though outside contributors to Ark have been primarily folks deeply familiar with K8s and the dev environment it requires. PR #1131 got me started wondering about k8s newcomers -- although that user seems not to have been a potential code contributor (at least, not yet). IFF y'all want to support newcomer contributions, I think there's quite a bit of material missing. See also TODOs in other files.
Copy link
Contributor

Choose a reason for hiding this comment

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

Add some refs to CRDs/controllers as relevant pre-req knowledge

@@ -0,0 +1,3 @@
* Test your build
Copy link
Contributor

Choose a reason for hiding this comment

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

Add some general guidelines on getting your build deployed, some standard flows to go through, where to look for success/failure/diagnostic info

@Bradamant3
Copy link
Contributor Author

Bradamant3 commented Jan 4, 2019

n.b. please long TODO in new documentation.md. More food for thought, approaches, ideas, reminders of additional content to include.

@skriss skriss added this to the v1.0.0 milestone Mar 13, 2019
@skriss skriss modified the milestones: v1.0.0, v1.x May 20, 2019
@skriss
Copy link
Contributor

skriss commented Jun 4, 2019

Sorry @Bradamant3 but I'm going to close this PR as it's stale :) We have xrefs to it in the relevant issues so we can mine it for content if/when we work on those issues.

@skriss skriss closed this Jun 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants