loopbackio / loopbackio/loopback-next
Update IBM Cloud Foundry Public deployment docs with deprecation notice
Open
Nobody has claimed this yet.
Docs
- Dominant language
- TypeScript
- Stars
- 5.1k
- Forks
- 1.1k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 27
Description
IBM Cloud Foundry Public has been deprecated (EOL is on 1 June 2023). We should update the documentation with a warning banner. The intention is to:
- inform users of the deprecation allowing
- Allow existing IBM Cloud Foundry Public users to continue referencing the documentation
- Allow existing non-IBM flavoured (e.g. FOSS, VMware Tanzu Application Runtime) to continue referencing the documentation
The following are out-of-scope:
- Creating generic (i.e. non-vendor, FOSS-based) documentation for Cloud Foundry deployments.
- Updating the CLI to generate a Cloud Foundry app manifest which can be universally-deployed to most Cloud Foundry deployments.
- Updating the CLI to generate Paketo Buildpacks, which is a flavour of Cloud Native Buildpack ("CNB", also known as "v3 Buildpacks") natively supported by cf-for-k8s (Cloud Foundry on Kubernetes, now in maintenance mode) and Korifi (the upcoming successor for cf-for-k8s).
Reference
- https://github.com/loopbackio/loopback-next/blob/244e58c2672d0349f8c64d00f778b9baae1c43ba/docs/site/deployment/Deploying-to-IBM-Cloud.md
- https://github.com/ibm-cloud-docs/cloud-foundry-public/commit/0afc8e94429ad0e5419957698bd93d54a13730a9
- https://cloud.ibm.com/docs/cloud-foundry-public?topic=cloud-foundry-public-deprecation
Contributor guide
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
Open docs/site/deployment/Deploying-to-IBM-Cloud.md and review the linked IBM Cloud deprecation notice for the relevant wording and timing. Add a warning banner that explains the IBM Cloud Foundry Public deprecation while keeping the existing documentation useful for IBM and other Cloud Foundry deployments.
Written by the indexing model from the issue text.
Assessment
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100