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

edited the eds docs #1189

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

Conversation

maryann-macrometa
Copy link
Collaborator

Made some edits to EDS, especially the quickstart section. Want to be sure it's right .

Copy link

vercel bot commented Jun 5, 2024

@maryann-macrometa is attempting to deploy a commit to the Team Macrometa Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@dlozina-macrometa dlozina-macrometa left a comment

Choose a reason for hiding this comment

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

Very good, minor comments are added.

## May 2024 Release
### v1.001
Copy link
Contributor

Choose a reason for hiding this comment

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

We use semver notation for vesions: https://semver.org/
This needs to be 1.0.0

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

fixed

Copy link
Contributor

Choose a reason for hiding this comment

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

It is better to use GUI images for docs, and when we need to display terminal output, we can use bash code comments. It is easier for developers to see what is happening, and they can also copy-paste from the docs, for example, the same filter while testing. What is marked on the image my suggestion is to move it to a line text explanation

Copy link
Contributor

@dlozina-macrometa dlozina-macrometa left a comment

Choose a reason for hiding this comment

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

👍

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