spring-cloud-dataflow-samples icon indicating copy to clipboard operation
spring-cloud-dataflow-samples copied to clipboard

Inventory the samples we should support (delete the irrelevant/unwanted ones)

Open onobc opened this issue 3 years ago • 2 comments

Proposed inventory below.

A good next step would be to go through the docs (Microsite, etc...) and be sure that none of the samples in the "to delete" category are referenced in the docs. And if they are referenced and we still want to drop support - then remove them from the docs.

onobc avatar Jan 25 '22 15:01 onobc

Original list proposed by @cppwfs

Keep:

✅ transition-sample ✅ timestamp-task ✅ timestamp-batch ✅ scenario-task ✅ monitoring-samples ✅ kafka-samples ✅ security-ldap-uaa-example ✅ java-dsl ✅ function-samples ✅ dataflow-website ✅ dataflow-template-example ✅ file-ingest

Discuss

? spring-cloud-stream-function-bindings (refer them to the spring cloud stream apps?) ? dataflow-template-load-generator ? keystore ? multi-io-samples ? keystore ? dataflow-zuul ? custom-dataflow-builds

Discard:

❌ dataflow-migrate-schedules

onobc avatar Jan 25 '22 16:01 onobc

With my recent updates to the SCDF ref guid and Microsite...

The Microsite and/or SCDF ref guide references only these:

  • ✅ dataflow-website/**
  • ✅ transition-sample

I'm not sure exactly how these are referenced but I am pretty sure they are used (we just moved them over here)

  • ✅ timestamp-task
  • ✅ timestamp-batch
  • ✅ scenario-task

This is reference in SCDF /Users/cbono/repos/spring-cloud-dataflow/src/docker-compose/docker-compose-ssl.yml

  • ✅ keystore

ℹ️ The above items should be the only ones considered "active" in this repo and therefore they should be kept up-to-date w/ versions etc..


These are not being used/referenced anywhere now - we should leave them in the repo for now but mark them loudly as deprecated/read-only in the top-level-readme as well as at the top of each of their readme.

  • monitoring-samples
  • kafka-samples
  • security-ldap-uaa-example
  • java-dsl
  • function-samples
  • file-ingest (these have coverage under dataflow-website and are not referenced anywhere)
  • dataflow-template-example
  • dataflow-template-load-generator
  • multi-io-samples
  • dataflow-zuul
  • custom-dataflow-builds

Additionally, our CI is building and publishing these but nobody is referencing them. We should remove them from CI if we move forward w/ these being "deprecated":

  • kafka-samples
  • multi-io-samples/ticktock
  • multi-io-samples/purchase-orders/http-purchase-orders
  • multi-io-samples/kafka-streams/user-clicks-per-region-1.2.x
  • function-samples
  • monitoring-samples

onobc avatar Feb 04 '22 17:02 onobc