Skip to content

[Merged by Bors] - Docs: new usage guide and index page #229

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

Closed
wants to merge 12 commits into from

Conversation

fhennig
Copy link
Contributor

@fhennig fhennig commented Apr 12, 2023

Description

Please add a description here. This will become the commit message of the merge request later.

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes
# Author
- [ ] Changes are OpenShift compatible
- [ ] CRD changes approved
- [ ] Helm chart can be installed and deployed operator works
- [ ] Integration tests passed (for non trivial changes)
# Reviewer
- [ ] Code contains useful comments
- [ ] (Integration-)Test cases added
- [ ] Documentation added or updated
- [ ] Changelog updated
- [ ] Cargo.toml only contains references to git tags (not specific commits or branches)
# Acceptance
- [ ] Feature Tracker has been updated
- [ ] Proper release label has been added

Once the review is done, comment bors r+ (or bors merge) to merge. Further information

@fhennig fhennig marked this pull request as ready for review April 13, 2023 09:59
Copy link
Member

@razvan razvan left a comment

Choose a reason for hiding this comment

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

Some ideas for the diagram:

  • remove the ...-driver-pod-spec-conf-map since it's not created by the operator
  • remove the ...-submit-job config map. It's only needed for logging of the spark-submit output. Rather irrelevant for a first high level diagram.
  • maybe use a different shapes (not just colors) for different objects and get rid ot the large ServiceAccount or ConfigMap titles.
  • maybe also integrate the history server with the S3 bucket for the event files.

@fhennig
Copy link
Contributor Author

fhennig commented Apr 17, 2023

I've cleaned up the diagram and added more info on the history server. @razvan

Copy link
Member

@razvan razvan left a comment

Choose a reason for hiding this comment

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

nice

@fhennig
Copy link
Contributor Author

fhennig commented Apr 17, 2023

bors merge

bors bot pushed a commit that referenced this pull request Apr 17, 2023
# Description

*Please add a description here. This will become the commit message of the merge request later.*



Co-authored-by: Felix Hennig <[email protected]>
Co-authored-by: Razvan-Daniel Mihai <[email protected]>
@bors
Copy link

bors bot commented Apr 17, 2023

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Docs: new usage guide and index page [Merged by Bors] - Docs: new usage guide and index page Apr 17, 2023
@bors bors bot closed this Apr 17, 2023
@bors bors bot deleted the docs/new-usage-and-index branch April 17, 2023 10:39
fhennig added a commit that referenced this pull request Apr 18, 2023
*Please add a description here. This will become the commit message of the merge request later.*

Co-authored-by: Felix Hennig <[email protected]>
Co-authored-by: Razvan-Daniel Mihai <[email protected]>
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