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

Umbrella issue for docs cleanup #43

Closed
5 tasks done
kevin-bates opened this issue Jan 20, 2023 · 2 comments
Closed
5 tasks done

Umbrella issue for docs cleanup #43

kevin-bates opened this issue Jan 20, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@kevin-bates
Copy link
Member

kevin-bates commented Jan 20, 2023

The docs are in place and building, but still contain information that is only relative to Enterprise Gateway and really needs a series of passes (per #43 (comment) below). As a result, I've decided to turn this issue into an umbrella issue so that this work can be more easily distributed (as necessary).

@kevin-bates kevin-bates added the documentation Improvements or additions to documentation label Jan 20, 2023
@kevin-bates
Copy link
Member Author

kevin-bates commented Feb 2, 2023

Here are some quick (and rough) notes I took in making a pass through the document's Table of Contents. The items prefixed with 'x' represent areas that require significant changes, while those prefixed with '-' indicate that minor changes are required. Those not prefixed seem to be okay, but should not be precluded from additional checks.

Table of Contents
xUsers
x    Connecting the server to Enterprise Gateway (make general and explain local use vs remote use)
-    Kernel Environment Variables (still some EG refs)
Operators
x    Deploying Gateway Provisioners (introduce/reference tooling, )
-    Configuring Gateway Provisioners
Developers
    Implementing a remote provisioner
-    Implementing a kernel launcher (links to EG, add some python code examples)
x    Implementing a kernel specification (introduce/reference tooling, )
x    Custom Kernel Images (add note that EG kernel images should be compatible, reference the docker-stacks base image and no others, and the kernel-image Dockerfile, should code-snippets for injecting )
-    API Docs (fixup section descriptions - probably from top of file help string, try to remove TrackKernelOnHost, KernelChannel, gp_launch_kernel, why is RemoteProvisionerBase listed twice?)
xContributors (still EG)
    Contributing to Gateway Provisioners
x    System Architecture (Update hierarchy image, EG refs in {Kubernetes,DockerSwarm}Provisioner, Remove CustomResourceProv, Update Launchers example, )
x    Docker Images - reiterate EG b/c, remove eg-image refs, replace with Dockerfile examples?
    Development Workflow
x    Sequence Diagrams (Generalize EG to Gateway Server)
    API Docs - linked to dev (ok)
X    Debugging Jupyter Enterprise Gateway (update images)
Other
x    Troubleshooting Guide (EG refs, remove old stale stuff)
x    Related Resources (EG ref)

@kevin-bates kevin-bates changed the title Cleanup docs Umbrella issue for docs cleanup Feb 2, 2023
@kevin-bates
Copy link
Member Author

Tasks have been completed and docs have reached a minimally viable state - closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant