Skip to content

feat: Adding FST architecture diagrams & documentation#387

Closed
deepak-swirlds wants to merge 4 commits intomainfrom
add-infra-design-docs
Closed

feat: Adding FST architecture diagrams & documentation#387
deepak-swirlds wants to merge 4 commits intomainfrom
add-infra-design-docs

Conversation

@deepak-swirlds
Copy link
Copy Markdown
Contributor

@deepak-swirlds deepak-swirlds commented Oct 5, 2023

Description

This pull request changes the following:

  • Adds documentation under docs/ folder

Related Issues

Signed-off-by: Deepak Mishra <deepak@swirldslabs.com>
@deepak-swirlds deepak-swirlds self-assigned this Oct 5, 2023
@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 9, 2023

Unit Test Results

  23 files  ±0    23 suites  ±0   49s ⏱️ ±0s
103 tests ±0    99 ✔️ ±0  4 💤 ±0  0 ±0 
104 runs  ±0  100 ✔️ ±0  4 💤 ±0  0 ±0 

Results for commit a30fad5. ± Comparison against base commit 0b7ae17.

♻️ This comment has been updated with latest results.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Oct 9, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

- Platform Configuration
- config.txt
- Node Software Address Books
- account 101 .bin
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
- account 101 .bin
- account 101 .bin

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

what is the reason why 'get IPs of statefulset(s)' is listed twice?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

what is the reason why '[all pods] copy hedera-build.zip' is listed twice?

@deepak-swirlds deepak-swirlds changed the title feat: Adding documentation feat: Adding FST architecture diagrams & documentation Oct 11, 2023
Copy link
Copy Markdown
Member

@leninmehedy leninmehedy left a comment

Choose a reason for hiding this comment

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

Let's keep design docs in Notion until it is finalized. I don't see the need of merging it and store in the repo yet.

When we are merging interface definitions after a design sprint/round, we need to ensure proper doc blocks are added so that we can auto-generate proper java doc.

@leninmehedy
Copy link
Copy Markdown
Member

@deepak-swirlds Let's put the design docs in Notion here and close this PR.

@leninmehedy
Copy link
Copy Markdown
Member

Closing it as discussed

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.

feat: Add FST architecture documentation with diagrams

3 participants