SAP-samples / SAP-samples/cf-mta-examples
Example: Content deployment - no information on the structure of the content.zip archive
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 153
- Forks
- 53
- PR merge metrics
- No merged PRs in 30d
Description
The readme file only mentions that there should be a zip archive containing the web apps but it doesn't specify more. I went ahead and downloaded the archive from https://github.com/SAP-samples/cf-mta-examples/tree/master/content-deployment/content to investigate its internal structure.
I saw that it uses the following structure:
content.zip
|── webapp1.zip
|── webapp2.zip
|── webapp3.zip
| |── manifest.json
| |── xs-app.json
| |── ...
My ask would be to add this information to the readme to make it easier to find.
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 with the README section for content deployment and inspect the content directory linked in the issue to confirm the content.zip layout. Document the nested webapp archives and the manifest.json and xs-app.json files shown in the issue; done when the README explains the archive structure clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100