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

Ref/docs #450

Merged
merged 25 commits into from
Aug 14, 2023
Merged

Ref/docs #450

merged 25 commits into from
Aug 14, 2023

Conversation

m1ghtym0
Copy link
Member

Proposed changes

  • Update some wording and smaller changes
  • Refactor Getting-started into a single quickstart with tabs + install guide
  • Refactor Deployment into Kubernetes vs Standalone. Add platform overview.
  • Add architecture section
  • Add keys and crypto page similar to Constellation

Additional info

  • Please review the refactored sections. Do you like the changes? Is the first-steps and deployment flow easier to follow now?
  • Please read the keys and crypto page. Are the details correct? Is it comprehensible? Any comments on the graphics? I'll polish them after your feedback.

@netlify
Copy link

netlify bot commented Jul 27, 2023

Deploy Preview for marblerun-docs ready!

Name Link
🔨 Latest commit 5ddd069
🔍 Latest deploy log https://app.netlify.com/sites/marblerun-docs/deploys/64d5e9e09043ec00089f772a
😎 Deploy Preview https://deploy-preview-450--marblerun-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@thomasten thomasten left a comment

Choose a reason for hiding this comment

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

High-level review:

  • Rearrangements of Getting started and Deployment LGTM
  • Keys and crypto
    • Some remarks on the details, see below
    • Structure and scope makes sense to me
    • Graphics are helpful. No ideas for improvements here.

docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
@m1ghtym0
Copy link
Member Author

m1ghtym0 commented Aug 4, 2023

Link checks fail due to the updated sections not being in the currently published version of the docs.

@m1ghtym0 m1ghtym0 marked this pull request as ready for review August 4, 2023 07:17
@m1ghtym0 m1ghtym0 requested a review from flxflx August 4, 2023 07:18
docs/docs/architecture/coordinator.md Outdated Show resolved Hide resolved
docs/docs/architecture/marbles.md Outdated Show resolved Hide resolved
docs/docs/deployment/platforms/alibaba.md Outdated Show resolved Hide resolved
docs/docs/deployment/platforms/alibaba.md Outdated Show resolved Hide resolved
docs/docs/deployment/platforms/alibaba.md Outdated Show resolved Hide resolved
docs/docs/intro.md Outdated Show resolved Hide resolved
docs/docs/intro.md Outdated Show resolved Hide resolved
docs/sidebars.js Outdated Show resolved Hide resolved
docs/sidebars.js Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Show resolved Hide resolved
m1ghtym0 and others added 5 commits August 7, 2023 07:10
docs/docs/getting-started/quickstart.md Outdated Show resolved Hide resolved
docs/docs/features/recovery.md Outdated Show resolved Hide resolved
docs/docs/architecture/marbles.md Outdated Show resolved Hide resolved
docs/docs/_media/security_architecture.svg Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/features/recovery.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/styles/Vocab/edgeless/accept.txt Outdated Show resolved Hide resolved
m1ghtym0 and others added 3 commits August 9, 2023 07:51
Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com>
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/building-enclaves/occlum.md Outdated Show resolved Hide resolved
Co-authored-by: Daniel Weiße <66256922+daniel-weisse@users.noreply.github.com>
@m1ghtym0
Copy link
Member Author

Copy link
Member

@daniel-weisse daniel-weisse left a comment

Choose a reason for hiding this comment

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

Looks good from my side

docs/docs/_media/enc-state-single.svg Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/deployment/platforms/alibaba.md Outdated Show resolved Hide resolved
docs/docs/deployment/platforms/on-prem.md Outdated Show resolved Hide resolved
docs/docs/deployment/platforms/on-prem.md Outdated Show resolved Hide resolved
docs/docs/features/kubernetes-integration.md Outdated Show resolved Hide resolved
docs/docs/features/recovery.md Outdated Show resolved Hide resolved
docs/docs/architecture/coordinator.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/getting-started/quickstart.md Outdated Show resolved Hide resolved
Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
docs/sidebars.js Outdated Show resolved Hide resolved
@m1ghtym0
Copy link
Member Author

Applied your suggestions please take another look @thomasten @flxflx

docs/docs/architecture/security.md Outdated Show resolved Hide resolved
docs/docs/features/kubernetes-integration.md Outdated Show resolved Hide resolved
Co-authored-by: Thomas Tendyck <51411342+thomasten@users.noreply.github.com>
@m1ghtym0 m1ghtym0 merged commit daae815 into master Aug 14, 2023
6 of 7 checks passed
@m1ghtym0 m1ghtym0 deleted the ref/docs branch August 14, 2023 06:40
@thomasten thomasten mentioned this pull request Aug 16, 2023
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.

4 participants