-
Epic
-
Resolution: Unresolved
-
Normal
-
None
-
None
-
None
-
Review MicroShift upstream documentation at GitHub
-
Proactive Architecture
-
False
-
-
False
-
Not Selected
-
To Do
-
OCPSTRAT-797Enhance MicroShift Community experience
-
100% To Do, 0% In Progress, 0% Done
Epic Goal
- Make sure all the upstream documentation is correct and up-to-date
- Remove duplications with production documentation when possible
- If functionality gaps are discovered in the process, open follow-up tickets
Why is this important?
- Upstream docs should be kept up-to-date to augment the production documentation
Acceptance Criteria
- All upstream documents reviewed and either corrected or deleted in favor of production documents
$ find . -name \*.md | grep -vE '/vendor/|/.github/' ./ansible/README.md ./cmd/generate-config/README.md ./cockpit-plugin/README.md ./docs/contributor/devenv_cloud.md ./docs/contributor/enabled_apis.md ./docs/contributor/greenboot.md ./docs/contributor/howto_quay_mirror.md ./docs/contributor/multinode/config_r4e.md ./docs/contributor/multinode/config_rpm.md ./docs/contributor/multinode/setup.md ./docs/contributor/network/default_cni_plugin.md ./docs/contributor/network/host_networking.md ./docs/contributor/network/ovn_kubernetes_traffic_flows.md ./docs/contributor/network/multus.md ./docs/contributor/openshift_ci.md ./docs/contributor/storage/configuration.md ./docs/contributor/storage/default_csi_plugin.md ./docs/contributor/updateability.md ./docs/contributor/design.md ./docs/contributor/rhel4edge_iso.md ./docs/contributor/devenv_setup.md ./docs/contributor/rpm_packages.md ./docs/contributor/rebase.md ./docs/contributor/layered_product_ci.md ./docs/contributor/image_mode.md ./docs/user/greenboot.md ./docs/user/howto_amq_broker.md ./docs/user/howto_firewall.md ./docs/user/howto_http_proxy.md ./docs/user/howto_kubeconfig.md ./docs/user/howto_load_balancer.md ./docs/user/howto_mirror_images.md ./docs/user/howto_pod_security.md ./docs/user/howto_sysconf_watch.md ./docs/user/known_limitations.md ./docs/user/howto_offline_containers.md ./docs/user/howto_test_offline.md ./docs/user/debugging_tips.md ./docs/user/getting_started.md ./docs/user/howto_config.md ./hack/reference-workload/readme.md ./packaging/imagemode/README.md ./scripts/jira/README.md ./scripts/review-dashboard/README.md ./scripts/sos-to-loki/README.md ./scripts/docs-preview/README.md ./test/README.md ./README.md
Dependencies (internal and external)
- Red Hat Build for MicroShift 4.17 - production documentation
Open questions::
- None