Add documentation #8

dimakuv · 2021-09-10T11:43:33Z

Documentation config is taken from the core Gramine repo and slightly modified (C specific configs are replaced/removed). The main text is taken from the core repo's manpages/gsc.rst.

NOTE: This commit ideally would be merged after commits that modify GSC files to use gramine words everywhere instead of graphene. Because the description of GSC is updated in this commit to use these gramine commands. But on the other hand, it's Ok to have a slightly wrong docs for one commit (this makes merging PRs in different repos easier).

This change is

mkow

Reviewed 11 of 11 files at r1, all commit messages.
Reviewable status: all files reviewed, 6 unresolved discussions, not enough approvals from maintainers (1 more required), not enough approvals from different teams (1 more required, approved so far: Intel) (waiting on @dimakuv)

-- commits, line 5 at r2:
C specific -> C-specific

Documentation/index.rst, line 9 at r2 (raw file):

.. warning::
    GSC is still under development and must not be used in production! Please
    see `issue #1520 <https://github.com/gramineproject/graphene/issues/1520>`__

I moved this to #13, could you fix up the link?

Documentation/index.rst, line 400 at r2 (raw file):

Graine

Another candidate for the new name? ;P

Documentation/index.rst, line 454 at r2 (raw file):

This document focuses on the most important limitations of GSC.
`Issue #1520 <https://github.com/gramineproject/graphene/issues/1520>`__

ditto

Documentation/index.rst, line 510 at r2 (raw file):

   sgx.trusted_files = [ "file:excluded_file1", "file:excluded_file2" ]
   or
   sgx.allowed_files = [ "file:excluded_file3", "file:excluded_file4" ]

This "excluded" may be confusing, sounds like you're adding here more files to be excluded.

Documentation/requirements.txt, line 3 at r2 (raw file):

sphinx==1.8.0
breathe<4.13.0
sphinx_rtd_theme

Could you update this to sphinx_rtd_theme<1? (context: gramineproject/gramine#62)

Documentation config is taken from the core Gramine repo and slightly modified (C-specific configs are replaced/removed). The main text is taken from the core repo's `manpages/gsc.rst`. Note that the description of GSC is updated to use `gramine` word everywhere. Signed-off-by: Dmitrii Kuvaiskii <[email protected]>

dimakuv

Reviewable status: 9 of 11 files reviewed, 6 unresolved discussions, not enough approvals from maintainers (1 more required), not enough approvals from different teams (1 more required, approved so far: Intel) (waiting on @mkow)

-- commits, line 5 at r2: