-
Notifications
You must be signed in to change notification settings - Fork 4
WIP: Unified platform docs #780
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
Draft
gavinelder
wants to merge
24
commits into
master
Choose a base branch
from
unified_docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Llewellyn vd Berg <[email protected]>
Signed-off-by: Gavin <[email protected]>
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The following is a demo of building our enterprise and cloud-doc sets together at the same time.
High level overview
enterprise-
orcloud-
Next Steps
This will give us a process for engineering to maintain a single source of truth.
We can then take these unified docs content as a single item into the internal platform codebase.
The workflow would then be to sync the content from platform -> docs :
Cut an enterprise versioned release which exists inside the docs repo.
Longer term vision
We can remove the need to vendor versions in this repository but first we should make some optimizations such as shared image content etc.
Note
This PR does not consolidate content -- this needs to be done once we have agreement on this approach and if it's beneficial.