loopbackio / loopbackio/loopback-next

Update IBM Cloud Foundry Public deployment docs with deprecation notice

Open
#9,090 0 comments 0 reactions 0 assignees View on GitHub

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:

  1. inform users of the deprecation allowing
  2. Allow existing IBM Cloud Foundry Public users to continue referencing the documentation
  3. Allow existing non-IBM flavoured (e.g. FOSS, VMware Tanzu Application Runtime) to continue referencing the documentation

The following are out-of-scope:

  1. Creating generic (i.e. non-vendor, FOSS-based) documentation for Cloud Foundry deployments.
  2. Updating the CLI to generate a Cloud Foundry app manifest which can be universally-deployed to most Cloud Foundry deployments.
  3. 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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.