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.

Sign up for GitHub

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

Jump to bottom

[Documentation] clean up tutorial code and consolidate all instructions #110

Open
4 of 6 tasks
maia-iyer opened this issue Jan 13, 2023 · 3 comments
Open
4 of 6 tasks

[Documentation] clean up tutorial code and consolidate all instructions #110

maia-iyer opened this issue Jan 13, 2023 · 3 comments
Labels
backend Tornjak API (Backend) documentation Improvements or additions to documentation frontend Tornjak UI (Frontend)

Comments

@maia-iyer
Copy link
Collaborator

maia-iyer commented Jan 13, 2023 •
edited
Loading

  • consolidate all uses of tornjak agent vs tornjak backend terms
  • create versioning system for all images
  • remove the dev instructions from the front page - maybe make separate docs for development
  • quickstart files need renaming and maybe one central file to point to the rest
  • README: add index + simple architecture diagram (suggestion by @mamy-CS)
  • Tornjak quickstart file indexing (suggestion by @mamy-CS)

[edited to consolidate comments]
@maia-iyer maia-iyer added the documentation Improvements or additions to documentation label Jan 13, 2023
@maia-iyer
Copy link
Collaborator Author

#114 takes care of the third and fourth bullet points

@mamy-CS
Copy link
Collaborator

mamy-CS commented Feb 22, 2023 •
edited
Loading

A couple of comments:

  • On README, Get Started: It will be very helpful if we add indexing on what components need to be started to get Tornjak up and running
  • Putting the architecture diagram at least for agent mode, right before Get started will help too
  • In tornjak-quickstart file, same as the indexing we have on top for setting up SPIRE server config having a more general indexing including backend and frontend will be awesome.
  • Contributing file looks awesome

@maia-iyer
Copy link
Collaborator Author

@mamy-CS recent changes to the quickstart via #138 - does this address your comment?

@mrsabath mrsabath added frontend Tornjak UI (Frontend) backend Tornjak API (Backend) labels Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backend Tornjak API (Backend) documentation Improvements or additions to documentation frontend Tornjak UI (Frontend)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@mrsabath @maia-iyer @mamy-CS