Update Humanitec integration docs to contain newly supported resources #2502
Conversation
…or Deployment Deltas, Deployment Sets, Secret Stores, Shared Values, Users, Groups, and Pipelines. Update HumanitecExporter to support syncing these new entities and improve error handling in API calls. Refactor existing code for better clarity and maintainability.
…ties such as pipelines, deployment deltas, deployment sets, secret stores, shared values, value set versions, users, and groups for improved clarity on synchronization capabilities.
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
There was a problem hiding this comment.
Some of the comments apply to other places and should replicated as same like the headings, the click to drops, the numbered list in a numbered list.
also for the sidebar we can have something like
Overview Set up data model Implementation Add GitHub secrets Add python scripts Add GitHub workflow
docs/guides/templates/humanitec/_humanitec_deployment_deltas.mdx
Outdated
Show resolved
Hide resolved
…on use cases, and updated workflow setup instructions. Added new images and improved section headers for clarity. Updated summary for blueprint templates to include "Click to expand" for better user experience.
…larity, correcting the image filename, and removing unnecessary tip formatting in the setup section.
|
Claude finished @lordsarcastic's task —— View job PR Review: Humanitec Integration Documentation UpdatesI've completed a comprehensive review of this PR according to the repository's contributing guidelines. Here's my detailed feedback: Todo List:
📝 Review SummaryThis PR significantly enhances the Humanitec integration documentation by adding support for 7 new resource types. The changes are well-structured and comprehensive, but there are several areas for improvement to align with the repository's contributing guidelines. ✅ Strengths
🔧 Issues & RecommendationsCritical Issues
Content Issues
Structural Issues
Implementation Code Review
📋 Specific Line-by-Line FeedbackMain Integration Guide (
|
| Guideline | Status | Notes |
|---|---|---|
| Capitalization | Header caps good, but some inconsistencies | |
| Tone & Style | ✅ Good | Uses "we" language appropriately |
| Lists | ❌ Needs work | Missing periods, nested structure issues |
| Links | ✅ Good | All use full paths |
| Images | Path looks correct but needs verification | |
| Code Examples | ✅ Good | Proper showLineNumbers usage |
| Formatting | Some inconsistencies in summary/details |
🏁 Conclusion
This is a solid enhancement to the Humanitec integration documentation. The core content is valuable and well-implemented. With the formatting and consistency fixes mentioned above, this will be an excellent addition to the documentation.
The previous review feedback has been largely addressed, particularly around the GitHub workflow structure and blueprint setup instructions. The remaining issues are primarily formatting and consistency concerns that can be easily resolved.
Recommendation: Approve after addressing the high-priority formatting issues.
| <HumanitecApplicationBlueprint/> | ||
|
|
||
| <HumanitecEnvironmentBlueprint/> | ||
|
|
||
| ## Port blueprints | ||
| <HumanitecWorkloadBlueprint/> | ||
|
|
||
| Create the following blueprint definitions in port: | ||
| <HumanitecResourceGraphBlueprint/> | ||
|
|
||
| <HumanitecApplicationBlueprint/> | ||
| <HumanitecResourceBlueprint/> | ||
|
|
||
| <HumanitecEnvironmentBlueprint/> | ||
| <HumanitecSecretStores/> | ||
|
|
||
| <HumanitecWorkloadBlueprint/> | ||
| <HumanitecSharedValues/> | ||
|
|
||
| <HumanitecResourceGraphBlueprint/> | ||
| <HumanitecValueSetVersions/> | ||
|
|
||
| <HumanitecDeploymentSets/> | ||
|
|
||
| <HumanitecPipelines/> | ||
|
|
||
| <HumanitecDeploymentDeltas/> | ||
|
|
||
| <HumanitecUsers/> | ||
|
|
||
| <HumanitecGroups/> |
There was a problem hiding this comment.
| <HumanitecApplicationBlueprint/> | |
| <HumanitecEnvironmentBlueprint/> | |
| ## Port blueprints | |
| <HumanitecWorkloadBlueprint/> | |
| Create the following blueprint definitions in port: | |
| <HumanitecResourceGraphBlueprint/> | |
| <HumanitecApplicationBlueprint/> | |
| <HumanitecResourceBlueprint/> | |
| <HumanitecEnvironmentBlueprint/> | |
| <HumanitecSecretStores/> | |
| <HumanitecWorkloadBlueprint/> | |
| <HumanitecSharedValues/> | |
| <HumanitecResourceGraphBlueprint/> | |
| <HumanitecValueSetVersions/> | |
| <HumanitecDeploymentSets/> | |
| <HumanitecPipelines/> | |
| <HumanitecDeploymentDeltas/> | |
| <HumanitecUsers/> | |
| <HumanitecGroups/> | |
| <HumanitecApplicationBlueprint/> | |
| <HumanitecEnvironmentBlueprint/> | |
| <HumanitecWorkloadBlueprint/> | |
| <HumanitecResourceGraphBlueprint/> | |
| <HumanitecResourceBlueprint/> | |
| <HumanitecSecretStores/> | |
| <HumanitecSharedValues/> | |
| <HumanitecValueSetVersions/> | |
| <HumanitecDeploymentSets/> | |
| <HumanitecPipelines/> | |
| <HumanitecDeploymentDeltas/> | |
| <HumanitecUsers/> | |
| <HumanitecGroups/> | |
| ```suggestion | |
| <HumanitecApplicationBlueprint/> | |
| <HumanitecEnvironmentBlueprint/> | |
| <HumanitecWorkloadBlueprint/> | |
| <HumanitecResourceGraphBlueprint/> | |
| <HumanitecResourceBlueprint/> | |
| <HumanitecSecretStores/> | |
| <HumanitecSharedValues/> | |
| <HumanitecValueSetVersions/> | |
| <HumanitecDeploymentSets/> | |
| <HumanitecPipelines/> | |
| <HumanitecDeploymentDeltas/> | |
| <HumanitecUsers/> | |
| <HumanitecGroups/> |
|
|
||
| <HumanitecExporterPortClient/> | ||
| <HumanitecExporterPortClient/> | ||
|
|
||
| </details> | ||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Humanitec Client</summary> | ||
| <details> | ||
| <summary><b>Humanitec Client (Click to expand)</b></summary> | ||
|
|
||
| <HumanitecExporterHumanitecClient/> | ||
| <HumanitecExporterHumanitecClient/> | ||
|
|
||
| </details> | ||
| </details> | ||
|
|
||
|
|
||
| <details> | ||
| <summary>Cache</summary> | ||
| <details> | ||
| <summary><b>Cache (Click to expand)</b></summary> | ||
|
|
||
| <HumanitecExporterCacheScript/> | ||
| <HumanitecExporterCacheScript/> | ||
|
|
||
| </details> | ||
| </details> | ||
|
|
||
| 3. Create the file `.github/workflows/humanitec-exporter.yaml` in the `.github/workflows` folder of your repository. | ||
| ### Create the GitHub workflow | ||
|
|
There was a problem hiding this comment.
| <HumanitecExporterPortClient/> | |
| <HumanitecExporterPortClient/> | |
| </details> | |
| </details> | |
| <details> | |
| <summary>Humanitec Client</summary> | |
| <details> | |
| <summary><b>Humanitec Client (Click to expand)</b></summary> | |
| <HumanitecExporterHumanitecClient/> | |
| <HumanitecExporterHumanitecClient/> | |
| </details> | |
| </details> | |
| <details> | |
| <summary>Cache</summary> | |
| <details> | |
| <summary><b>Cache (Click to expand)</b></summary> | |
| <HumanitecExporterCacheScript/> | |
| <HumanitecExporterCacheScript/> | |
| </details> | |
| </details> | |
| 3. Create the file `.github/workflows/humanitec-exporter.yaml` in the `.github/workflows` folder of your repository. | |
| ### Create the GitHub workflow | |
| <details> | |
| <summary><b>Port Client (Click to expand)</b></summary> | |
| <HumanitecExporterPortClient/> | |
| </details> | |
| <details> | |
| <summary><b>Humanitec Client (Click to expand)</b></summary> | |
| <HumanitecExporterHumanitecClient/> | |
| </details> | |
| <details> | |
| <summary><b>Cache (Click to expand)</b></summary> | |
| <HumanitecExporterCacheScript/> | |
| </details> | |
|
Claude finished @lordsarcastic's task —— View job PR Review: Humanitec Integration Documentation UpdatesTodo List:
📝 Review SummaryThis PR successfully enhances the Humanitec integration documentation by adding support for 7 new resource types (Deployment Deltas, Deployment Sets, Secret Stores, Shared Values, Users, Groups, and Pipelines). The changes are comprehensive and well-implemented, with most previous review feedback addressed. However, there are still some formatting and consistency issues that need attention. ✅ Strengths
🔧 Issues & RecommendationsCritical Issues
Consistency Issues
Content Issues
Implementation Code
📋 Specific RecommendationsHigh Priority FixesLine 30: - This guide demonstrates how to create a GitHub worklow integration
+ This guide demonstrates how to create a GitHub workflow integrationLines 105-106: Add periods: - main.py` - Orchestrates the synchronization of data from Humanitec to Port, ensuring that resource entities are accurately mirrored and updated on your Port catalog
+ main.py` - Orchestrates the synchronization of data from Humanitec to Port, ensuring that resource entities are accurately mirrored and updated on your Port catalog.
- requirements.txt` - This file contains the dependencies or necessary external packages need to run the integration
+ requirements.txt` - This file contains the dependencies or necessary external packages needed to run the integration.Medium Priority ImprovementsBlueprint Component Spacing ( <HumanitecApplicationBlueprint/>
+
<HumanitecEnvironmentBlueprint/>
+
<HumanitecWorkloadBlueprint/>📊 CONTRIBUTING.md Compliance Check
🎯 Priority RecommendationsMust Fix Before Merge
Should Fix for Better UX
Nice to Have
🏁 ConclusionThis is a solid enhancement that significantly expands the Humanitec integration documentation capabilities. The core implementation is sound and follows established patterns well. Overall Assessment: ✅ Approve after fixing critical issues The high-priority fixes are minor and can be addressed quickly. The documentation structure, technical accuracy, and implementation quality are all excellent. Previous review feedback has been largely addressed, making this a valuable addition to the documentation. Once the typo and missing periods are fixed, this PR will be ready for merge. CONTRIBUTING.md Compliance: 85% ✅ (Minor formatting issues remain) |
|
Claude finished @lordsarcastic's task —— View job PR Review: Humanitec Integration Documentation UpdatesI've completed a comprehensive review of this PR according to the repository's contributing guidelines. Here's my detailed feedback: Todo List:
📝 Review SummaryThis PR significantly enhances the Humanitec integration documentation by adding support for 7 new resource types. The changes are well-structured and comprehensive, but there are several areas for improvement to align with the repository's contributing guidelines. ✅ Strengths
🔧 Issues & RecommendationsCritical Issues
Content Issues
Formatting Issues
📋 Specific Line-by-Line FeedbackMain Integration Guide (
|
| Guideline | Status | Notes |
|---|---|---|
| Capitalization | ✅ Good | Headers and general formatting follow guidelines |
| Tone & Style | ✅ Good | Uses "we" language appropriately, maintains friendly tone |
| Lists | ❌ Needs work | Missing periods on several list items |
| Links | ✅ Good | All use full paths as required |
| Images | ✅ Good | Proper path and width specification |
| Code Examples | ✅ Good | Proper showLineNumbers usage throughout |
| Summary/Details | ✅ Good | Consistent formatting with "Click to expand" |
🏁 Conclusion
This is a valuable enhancement to the Humanitec integration documentation. The core content is comprehensive and well-implemented. The issues identified are primarily minor formatting and grammar concerns that can be easily addressed.
The PR successfully addresses most of the previous review feedback and adds significant value by documenting support for 7 new Humanitec resource types. The implementation appears thorough and follows established patterns.
Recommendation: Approve after addressing the high-priority formatting issues (typo fix and missing periods).
Job run: https://github.com/port-labs/port-docs/actions/runs/16750267649
Description
Enhance Humanitec integration documentation by adding new templates for Deployment Deltas, Deployment Sets, Secret Stores, Shared Values, Users, Groups, and Pipelines. Update HumanitecExporter to support syncing these new entities.
Updated docs pages
Please also include the path for the updated docs
docs/guides/all/humanitec-integration)