-
Notifications
You must be signed in to change notification settings - Fork 11.5k
[docs] Transferring Nautilus docs from github repo to Sui docs #22180
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
base: main
Are you sure you want to change the base?
Conversation
…ion to relevant data access content
Co-authored-by: ronny-mysten <[email protected]>
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
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.
stamping since this is just copying over the doc
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.
I updated the pr with style guide changes. The biggest issue left is that I think this should be two docs, one in concepts, one in guides. Thoughts?
}, | ||
items: [ | ||
'concepts/cryptography/nautilus/nautilus-design', | ||
'concepts/cryptography/nautilus/using-nautilus', |
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.
Are we married to this setup? I think the nautilus design and overview page should be combined and the using nautilus page should go in the Guides section. There should then be a Related links level 2 heading at the end of each topic that points to each other...and other links that might be valuable.
I can do this to see if you like or no. Let me know.
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.
Hmm.. I get you, but would be great if we could leave it as is for now, to allow the builders who've seen the Github docs find the same format (that's how we structured it there).. Basically we're just looking to migrate for mainnet launch right now.. We could then do your suggested optimization a couple of months later as an improvement once we've a few more things to add (like TEE network partners that we would've by then)..
|
||
## FAQs | ||
|
||
1. There are many TEE providers available. Why did Sui choose AWS Nitro Enclaves initially? |
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.
This was answered on another page. Would be better to create a snippet that can be used in both places using {@include}. Would also suggest not using FAQ and just making these their own section.
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.
This is also something i can update.
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.
Yeah makes sense to me. Thanks for offering to update - would appreciate it :)
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.
Wasn't as clean as I assumed. Kept relatively as is but now have the questions appear on right nav for better discoverability.
- Configures required HTTP domains so the enclave can access external APIs via the parent EC2 instance (as the enclave itself has no internet access). | ||
- Exposes three endpoints to allow client-side communication with the enclave. | ||
|
||
When the enclave starts, it generates a fresh enclave key pair and exposes the following three endpoints: |
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.
I changed this to read three instead of two. Correct?
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.
oh right, sorry and thanks.. these were originally two, but then we added the third later, but didn't update that number :)
$ ENCLAVE_OBJECT_ID=0xe0e70df5347560a1b43e5954267cadd1386a562095cb4285f2581bf2974c838d | ||
``` | ||
|
||
You can view an example of an enclave config object containing PCRs [on SuiScan](https://testnet.suivision.xyz/object/0x58a6a284aaea8c8e71151e4ae0de2350ae877f0bd94adc2b2d0266cf23b6b41d). You can also view an [example of an enclave object](https://testnet.suivision.xyz/object/0xe0e70df5347560a1b43e5954267cadd1386a562095cb4285f2581bf2974c838d) containing the enclave public key. |
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.
I forgot to point out that we don't want to provide links to testnet data as there's no guarantee this info won't get wiped. We can address later but something to keep in mind on future writings.
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.
That's a good point, especially with the discussions on a potential testnet wipe. cc @joyqvq
Thanks for the changes, @ronny-mysten. We'll merge this next week once the changes go to mainnet. |
Description
Moving the Nautilus docs from github repo to the main Sui docs for mainnet release.
Test plan
NA
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.