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

Create a doc site for the k8s builder #66

Closed
jt-nti opened this issue Sep 27, 2022 · 5 comments
Closed

Create a doc site for the k8s builder #66

jt-nti opened this issue Sep 27, 2022 · 5 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jt-nti
Copy link
Member

jt-nti commented Sep 27, 2022

There are currently some docs in the form of a readme and markdown files in the docs folder, however it would be great to have a more user friendly doc site

For example the Hyperledger Besu project uses the MKDOCS_MATERIAL material docs insider:

@jt-nti jt-nti added documentation Improvements or additions to documentation hacktoberfest labels Sep 27, 2022
@jt-nti
Copy link
Member Author

jt-nti commented Sep 30, 2022

If you're here for hacktoberfest and have any questions, get in touch on our fabric-hacktoberfest Discord channel!

@jt-nti
Copy link
Member Author

jt-nti commented Oct 20, 2023

See October 2023 TOC meeting for a Documentation Task Force Update

Also, the new documentation should cover private images #96, and multi-arch Docker images #97.

jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue Jan 30, 2024
Resolves hyperledger-labs#66

Signed-off-by: James Taylor <[email protected]>
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue Jan 31, 2024
Resolves hyperledger-labs#66

Signed-off-by: James Taylor <[email protected]>
@jt-nti
Copy link
Member Author

jt-nti commented Feb 2, 2024

Include the following doc suggestion from @y12studio in #98

Warning: There are instances where the chaincode pod may continue to run even after its associated peer has disconnected. To conserve Kubernetes CPU and memory resources, it's advisable to remove these lingering pods. They can be identified and removed by their label: fabric-builder-k8s-peerid=peerID. For example, you can use the following command to locate these pods:

kubectl get pod -A -l app.kubernetes.io/created-by=fabric-builder-k8s,fabric-builder-k8s-peerid=peerID

@jt-nti jt-nti self-assigned this Feb 2, 2024
@jt-nti
Copy link
Member Author

jt-nti commented Feb 21, 2024

Make sure documentation covers everything required for running chaincode in a different namespace. @davidfdr reported that the fabric-builder-rolebinding namespace needs to match.

@jt-nti jt-nti added this to the Version 1 milestone Feb 27, 2024
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue May 17, 2024
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue May 20, 2024
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue May 20, 2024
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue May 21, 2024
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue May 21, 2024
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue May 21, 2024
jt-nti added a commit to jt-nti/fabric-builder-k8s that referenced this issue May 21, 2024
jt-nti added a commit that referenced this issue May 21, 2024
See #66

Signed-off-by: James Taylor <[email protected]>
@jt-nti
Copy link
Member Author

jt-nti commented May 21, 2024

@jt-nti jt-nti closed this as completed May 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant