Skip to content
This repository has been archived by the owner on Nov 13, 2024. It is now read-only.

[Docs] Minor documentation updates during walkthrough #46

Merged
merged 3 commits into from
Aug 15, 2024
Merged

[Docs] Minor documentation updates during walkthrough #46

merged 3 commits into from
Aug 15, 2024

Conversation

Olshansk
Copy link
Member

@Olshansk Olshansk commented Jul 25, 2024 •
edited
Loading

Updated some documentation while doing an end-to-end walkthrough.

commoddity
commoddity reviewed Jul 25, 2024
View reviewed changes
Copy link

@commoddity commoddity left a comment

Choose a reason for hiding this comment

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

Looks good over all, especially the changes to the docs but a few comments to discuss.

cmd/gateway_server/internal/transform/qos_node.go
@@ -1,9 +1,10 @@
package transform

import (
"math"
Copy link

Choose a reason for hiding this comment

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

why is this import added?

docker-compose.yml Outdated Show resolved Hide resolved
docker-compose.yml Outdated Show resolved Hide resolved
docs/api-endpoints.md Show resolved Hide resolved
.gitignore Outdated Show resolved Hide resolved
.env.sample Outdated Show resolved Hide resolved
@Olshansk Olshansk self-assigned this Aug 14, 2024
@Olshansk Olshansk added the documentation Improvements or additions to documentation label Aug 14, 2024
@Olshansk Olshansk changed the title [WIP][Draft] Olshansky docs walkthrough [Docs] Minor documentation updates during walkthrough Aug 14, 2024
@Olshansk Olshansk marked this pull request as ready for review August 14, 2024 16:42
@Olshansk
Copy link
Member Author

@nodiesBlade PTAL when you have a chance.

nodiesBlade
nodiesBlade approved these changes Aug 15, 2024
View reviewed changes
Copy link
Collaborator

@nodiesBlade nodiesBlade left a comment

Choose a reason for hiding this comment

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

skimmed through the changes, looks good. Minor formatting and comments

@Olshansk Olshansk merged commit 7587dad into main Aug 15, 2024
2 checks passed
@Olshansk Olshansk deleted the olshansk_walkthrough branch August 15, 2024 23:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@nodiesBlade nodiesBlade nodiesBlade approved these changes

@commoddity commoddity Awaiting requested review from commoddity

Assignees

@Olshansk Olshansk

Labels
documentation Improvements or additions to documentation
Projects
Shannon
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Olshansk @commoddity @nodiesBlade