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

add docs for offline #539

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

singhsaumya
Copy link
Contributor

Purpose

Sharing changes for visibility. I still need to update the image name for the service here.
Add initial documentation for service side changes for Offline Custom Commands

Does this introduce a breaking change?

[ ] Yes
[X ] No

Pull Request Type

Add document

[ ] Bugfix
[X] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

How to Test

N/A: Docs changes

  • Test the code
    N/A: Docs changes

What to Check

N/A: Docs changes

Other Information

@singhsaumya singhsaumya requested a review from a team as a code owner February 9, 2021 19:35
Copy link
Contributor

@ovishesh ovishesh left a comment

Choose a reason for hiding this comment

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

minor changes to structure requested


### The host computer

The host is an x-64 or arm-64 based computer that runs the Docker container.
Copy link
Contributor

Choose a reason for hiding this comment

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

could we add information about recommended space, memory and compute?

Copy link
Contributor

Choose a reason for hiding this comment

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

Just noticed it below. If we could structure all the pre-reqs together that will be awesome!


## Download Custom Commands container image with docker pull

Since, offline Custom Commands is an experimental feature, currently, you will only be able to consume it based on explicit approval. Please reach out to our team, and we can help you onboard.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would recommend to move this sentence to the top of this document as a note

@@ -0,0 +1,123 @@
# Running the Custom Command Embedded Service on Windows
Copy link
Contributor

Choose a reason for hiding this comment

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

The title says Windows. In the body of the document it includes other OS including macos and Linux. Is the document meant to cover all of them?

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.

3 participants