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

Cmd history docs #1685

Merged
merged 7 commits into from
Nov 8, 2024
Merged

Cmd history docs #1685

merged 7 commits into from
Nov 8, 2024

Conversation

jmthomas
Copy link
Member

@jmthomas jmthomas commented Nov 1, 2024

@jmthomas jmthomas requested a review from ryanmelt November 1, 2024 14:50
@jmthomas
Copy link
Member Author

jmthomas commented Nov 1, 2024

Roadmap formatting to have better checkboxes:
Screenshot 2024-11-01 at 8 51 23 AM

Copy link

codecov bot commented Nov 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.55%. Comparing base (500f7db) to head (5ecff0d).
Report is 20 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1685      +/-   ##
==========================================
+ Coverage   76.48%   76.55%   +0.07%     
==========================================
  Files         618      620       +2     
  Lines       46929    47097     +168     
  Branches      850      850              
==========================================
+ Hits        35892    36056     +164     
- Misses      10941    10946       +5     
+ Partials       96       95       -1     
Flag Coverage Δ
frontend 56.35% <ø> (+0.43%) ⬆️
python 83.94% <ø> (-0.02%) ⬇️
ruby-api 48.74% <ø> (ø)
ruby-backend 82.51% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member Author

@jmthomas jmthomas left a comment

Choose a reason for hiding this comment

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

@ryanmelt ready for review

@@ -1,6 +1,9 @@
---
sidebar_position: 4
title: Commands
description: Command definition file format and keywords
sidebar_custom_props:
myEmoji: 📡
Copy link
Member Author

Choose a reason for hiding this comment

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

I always hated the icons that went on those top level collection pages. I also updated the description throughout.
Screenshot 2024-11-06 at 1 49 01 PM

@@ -59,7 +67,8 @@ The cli runs as the default COSMOS container user which is the recommended pract

```batch
C:\openc3-project> cd openc3-cosmos-bob
openc3-cosmos-bob> openc3.bat cli generate target BOB
openc3-cosmos-bob> openc3.bat cli generate target BOB --python
Target BOB successfully generated!
Copy link
Member Author

Choose a reason for hiding this comment

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

I switched the default example to python

@@ -11,7 +14,7 @@ The following sections describe how to get OpenC3 COSMOS installed on various op

### PREREQUISITES

Install [Docker](https://docs.docker.com/get-docker/) and install [Docker Compose](https://docs.docker.com/compose/install/).
If you're on linux (recommended for production), we recommend installing Docker using your native package manager. Note: Red Hat users should read the [Podman](podman) documentation. If you're on Windows or Mac, install [Docker Desktop](https://docs.docker.com/get-docker/). All platforms also need to install [Docker Compose](https://docs.docker.com/compose/install/).
Copy link
Member Author

Choose a reason for hiding this comment

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

Added a note to clarify using native Docker on linux and only Docker Desktop on Mac and Windows

Copy link
Member

Choose a reason for hiding this comment

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

I generally install docker using the docker installation instructions: https://docs.docker.com/engine/install/
not a package manager. Note that the very top of this page points you to Docker Desktop which is confusing.


1. Do you license to foreign companies? How do you handle ITAR or the EAR?

We have several international customers and are not subject to ITAR export controls. We are export controlled under the EAR via ECCN 5D002c1. We have a detailed writeup explaining this justification as well as a commodity classification document from the Department of Commerce. Please contact us at sales@openc3.com for more information.
Copy link
Member Author

Choose a reason for hiding this comment

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

@ryanmelt These were taken straight from customer email requests. Please review for accuracy.

@@ -35,6 +38,8 @@ Command Authority is enabled in the Admin Console and is enabled scope wide. Onc

![Command Authority](/img/cmd_tlm_server/cmd_authority.png)

The other option shown in the Scope List is the Critical Command Mode. Critical commanding requires a different user to approve each command. It can either be enabled on just HAZARDOUS and RESTRICTED commands or on all manual commanding.

Copy link
Member Author

Choose a reason for hiding this comment

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

Just a blurb here about Critical Command Mode because it shows up on the Scopes page. I'm not sure where else we should document this.

}
function CardLink({ item }) {
const icon =
item?.customProps?.myEmoji ?? (isInternalUrl(item.href) ? "📄️" : "🔗");
Copy link
Member Author

Choose a reason for hiding this comment

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

This is the only line that I changed after 'swizzeling` the DocCard. I followed this example: facebook/docusaurus#10476

npm run swizzle @docusaurus/theme-classic DocCard -- --eject

- [x] Python Support
- [ ] Upgrade Tools to Vue 3 / Vuetify 3
- [ ] Plugin App Store
:white_check_mark:&nbsp;&nbsp;Python Support<br/>
Copy link
Member

Choose a reason for hiding this comment

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

We should move this down to COSMOS 5.x

@@ -11,7 +14,7 @@ The following sections describe how to get OpenC3 COSMOS installed on various op

### PREREQUISITES

Install [Docker](https://docs.docker.com/get-docker/) and install [Docker Compose](https://docs.docker.com/compose/install/).
If you're on linux (recommended for production), we recommend installing Docker using your native package manager. Note: Red Hat users should read the [Podman](podman) documentation. If you're on Windows or Mac, install [Docker Desktop](https://docs.docker.com/get-docker/). All platforms also need to install [Docker Compose](https://docs.docker.com/compose/install/).
Copy link
Member

Choose a reason for hiding this comment

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

I generally install docker using the docker installation instructions: https://docs.docker.com/engine/install/
not a package manager. Note that the very top of this page points you to Docker Desktop which is confusing.

Copy link

sonarqubecloud bot commented Nov 8, 2024

@jmthomas jmthomas merged commit 4c6bbdd into main Nov 8, 2024
27 checks passed
@jmthomas jmthomas deleted the cmd_history branch November 8, 2024 22:57
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.

2 participants