stride3d / stride3d/stride-docs
Deployment - Super Fast Track
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 39
- Forks
- 74
- Avg merge
- 3h 36m
- Merged PRs (30d)
- 2
Description
The Fast Track deployment process already optimizes by skipping certain steps, such as artifact creation. However, there are still some repetitive processes that could be skipped in the Super Fast Track deployment, especially if the Stride API hasn't changed. These are:
- Stride checkout - Takes around 47 seconds
- Build Stride API - Takes between 1 and 3 minutes
The Proposal
DocFX generates yml files based on the Stride build. In a Super Fast Track deployment, these yml files could be preserved and reused, further speeding up the deployment process. The main GitHub Actions workflow would overwrite these yml files with the most up-to-date ones as needed.
Manual Process Requirement
Preserving the yml files for this purpose would require a manual process:
- The
ymlfiles would have to be built locally. - These locally built files would then have to be pushed to the repository.
Use Case
This approach would be particularly beneficial for scenarios where frequent documentation updates are expected, which are unrelated to changes in the Stride API. The primary goal is to deploy these updates as rapidly as possible.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the main GitHub Actions workflow and the Fast Track and Super Fast Track deployment steps. Trace where DocFX generates the yml files, then determine how they can be preserved and reused when the Stride API is unchanged; done means the workflow skips the listed Stride steps while keeping documentation output current.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- devops, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100