Repository navigation
731 document high level roles and functions of the nodes making up the cn - #1173
Conversation
…ow-how-they-can-suggest-changes-to-the-docs' of https://github.com/simonletort-da/splice into simonletort-da/1034-From-the-docs-site,-users-do-not-know-how-they-can-suggest-changes-to-the-docs
update from @ethancohen-da based on gDoc suggested in https://github.com/global-synchronizer-foundation/docs/discussions/20#discussioncomment-12568745
|
@waynecollier-da, |
| Overview | ||
| ======== | ||
|
|
||
| ############ |
There was a problem hiding this comment.
why is this under deployment? This seems more like a background section
…anged the name of the file to overview.rst
|
Moved delpoyment.rst file to its own section named overview in the index.rst file and changed the name from delpoyment.rst to overview.rst |
@ethancohen-da did you push your changes? The PR looks unchanged to me since @moritzkiefer-da's feedback. |
…ow-how-they-can-suggest-changes-to-the-docs' into 731-Document-high-level-roles-and-functions-of-the-nodes-making-up-the-CN
|
|
||
| When making a change, rebuild the documentation using `sbt docs/bundle`. | ||
|
|
||
| ## Simplified build |
There was a problem hiding this comment.
I'm not fully convinced yet that we want and additional way to build docs; it increases complexity, adds maintenance overhead and with no one of the (core) devs using this route it can easily stop working without anyone noticing. So I'm not sure if in the long run we're simplifying the experience for non-developers with this at all.
In any case I suggest to make a separate PR for this and keep this PR small and focused only on the docs change described in the PR description. If nothing else, small PRs are easier to get reviews for.
There was a problem hiding this comment.
separate PR
Or maybe even just an issue at first for discussion...
| download_url = "/cn-release-bundles" | ||
| helm_repo_prefix = os.getenv("OCI_DEV_HELM_REGISTRY") | ||
| docker_repo_prefix = os.getenv("DEV_DOCKER_REGISTRY") | ||
| # with open(os.path.join(os.getenv("CANTON"), "SUBDIR")) as f: |
There was a problem hiding this comment.
This doesn't look very "ready for review" to me. Consider keeping PRs in draft until you consider them ready to merge.
|
About the failed Edit: added the |
martinflorian-da
added
the
static
|
This PR looks stale to me, closing but feel to reopen! |
|
@martinflorian-da Please re-open; we need this doc to be added to the Splice docs. It just needs to be reorganized slightly. |
As per Slack discussion: I'm assuming the authors here will not be finishing this PR, but it may very well be used as inspiration for whoever ends up completing #731 |
Update from @ethancohen-da based on gDoc suggested in https://github.com/global-synchronizer-foundation/docs/discussions/20#discussioncomment-12568745
Fixes #731
Pull Request Checklist
Cluster Testing
/cluster_teston this PR to request it, and ping someone with access to the DA-internal system to approve it./hdm_teston this PR to request it, and ping someone with access to the DA-internal system to approve it.PR Guidelines
Fixes #n, and mention issues worked on using#nMerge Guidelines