gh-action-test's People
Contributors
Watchers
gh-action-test's Issues
[Documentation] Upgrading Carbonmark to a new API version
What:
Document the process of upgrading Carbonmark to a new API version
Why:
To provide clear instructions for future upgrades.
How:
Details of steps involved in the upgrade, any necessary code changes, and testing procedures.
Expected Outcome:
- Comprehensive documentation for upgrading Carbonmark's API version.
Testing Criteria:
Ensure documentation covers all necessary steps and is easily understandable.
[Documentation] Subgraph changes and Carbonmark API
What:
Document how to handle subgraph changes in relation to the Carbonmark API.
Why:
To maintain consistency and reliability of the API during subgraph updates.
How:
Explanation of the impact of subgraph changes on the API, and how to manage these changes.
Expected Outcome:
- Clear guidelines on managing subgraph changes in the API.
Testing Criteria:
Documentation should address common scenarios and solutions.
[Documentation] Rollback a deployment
What:
Document the steps to rollback a deployment.
Why:
To provide a quick and reliable method for reverting changes in case of issues.
How:
Detailed instructions on how to safely rollback deployments.
Expected Outcome:
- Clear and concise rollback procedures.
Testing Criteria:
Ensure the documentation is thorough and covers different rollback scenarios.
[Documentation] Creating a manual release
What:
Document the procedure for creating a manual release.
Why:
To standardize the release process for manual deployments.
How:
Step-by-step instructions on the release process, including checks and balances.
Expected Outcome:
- A step-by-step guide for manual releases.
Testing Criteria:
The guide should be foolproof and easy to follow for developers.
[Documentation] Adding a route to Carbonmark API
What:
Document the addition of a new route to Carbonmark API
Why:
To guide developers in extending the API's capabilities.
How:
Include code snippets, route configurations, and any relevant examples.
Expected Outcome:
- Detailed guide on adding new routes to the Carbonmark API.
Testing Criteria:
Verify the documentation is complete and provides practical examples.
[Documentation] Previewing API changes in a deployment
What:
Document how to preview API changes in a deployment.
Why:
To allow developers to test and validate API changes before full deployment.
How:
Guide on setting up and accessing a preview environment for API changes.
Expected Outcome:
- Instructions for previewing API changes.
Testing Criteria:
The documentation should include steps for setup, testing, and accessing the preview.
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.