chore(docs): update gathered documentation (#704)

* chore(docs): update gathered documentation

* chore(docs): conditional/pod_definition updated

* chore(docs): clusterconfig/pod_network_connectivity_checks updated

* chore(docs): clusterconfig/tsdb_status updated

* chore(docs): clusterconfig/silenced_alerts updated

* chore(docs): clusterconfig/sap_license_management_logs updated

* chore(docs): clusterconfig/sap_pods updated

* chore(docs): update gathered-data

* chore(docs): clusterconfig/openshift_snd_logs updated

* chore(docs): clusterconfig/openshift_machine_api_events updated

* chore(docs): clusterconfig/openshift_logging updated

* chore(docs): update gathered-data

* chore(docs): clusterconfig/sheduler updated

* chore(docs): clusterconfig/sheduler_logs updated

* chore(docs): clusterconfig/openshift_authentication_logs updated

* chore(docs): clusterconfig/openshift_apiserver_operator_logs updated

* chore(docs): fixes scheduler_logs and openshift_authentication_logs docs

* chore(docs): clusterconfig/olm_operators updated

* chore(docs): clusterconfig/nodes updated

* chore(docs): clusterconfig/node_logs updated

* docs(chore): fixes clusterconfig/olm_operatos bp version

* chore(docs): clusterconfig/netnamespaces updated

* chore(docs): clusterconfig/mutating_webhook_configurations updated

* chore(docs): clusterconfig/machine_sets updated

* chore(docs): clusterconfig/machine_healthchecks updated

* chore(docs): clusterconfig/machine_configs updated

* feat(gendoc): generate link to sample files

* chore(docs): update gathered-data

* chore(docs): fixes bp versions

* chore(docs): clusterconfig/machine_configs updated

* chore(docs): clusterconfig/machine_autoscalers updated

* chore(docs): clusterconfig/kube_controller_manager_logs updated

* chore(docs): clusterconfig/jaegers updated

* chore(docs): clusterconfig/install_plans updated + clean global var

* chore(docs): clusterconfig/ceph_cluster updated

* chore(docs): update clusterconfig/active_alerts + unecessary global const

* chore(docs): update clusterconfig/certificate_signing_requests + unecessary global const

* chore(docs): clusterconfig/authentications updated

* chore(docs): clusterconfig/feature_gates updated

* chore(docs): clusterconfig/image updated

* chore(docs): clusterconfig/image_pruners updated

* chore(docs): clusterconfig/infrastructure updated

* chore(docs): clusterconfig/ingress updated

* chore(docs): clusterconfig/networks updated

* fix(image_registries) remove var from package scope

* chore(docs): clusterconfig/oauths updated

* chore(docs): clusterconfig/proxies updated

* refactor(service_accounts): remove global constant

* chore(docs): update gathered-data for preview

* chore(docs): clusterconfig/container_images updated

* chore(docs): clusterconfig/container_runtime_configs updated

* chore(docs): clusterconfig/cost_management_metrics_configs updated

* chore(docs): clusterconfig/custom_resource_definitions updated

* refactor(dvo_metrics): remove global scope variables

* chore(docs): clusterconfig/dvo_metrics updated

* chore(docs): clusterconfig/host_subnets updated

* chore(docs): clusterconfig/operators_pods_events updated

* chore(docs): update gathered-data

* chore(docs): clusterconfig/image_registries updated

* chore(docs): clusterconfig/operators updated

* chore(version): remove TODOs and create tracking task for it

* chore(docs): conditional/api_request_counts_of_resource_from_alert updated

* chore(docs): conditional/containers_logs

* chore(docs): conditional/logs_of_namespace updated

* chore(gendoc): clean up blankline

* chore(gendoc): simplify samplearchive regex

* chore(docs): conditional/image_streams_of_namespace updated

* chore(docs): fix missing sample data

* chore(docs): clusterconfig/config_maps updated

* chore(docs): clusterconfig/recent_metrics updated

* chore(docs): explicit minor version

* chore(docs): clusterconfig/namespaces_with_overlapping_uids updated

* chore(docs): clusterconfig/openshift_sdn_controller_logs updated

* chore(docs): clusterconfig/openshift_sdn_controller_logs and gathered-data updated

* chore(docs): remove conditional data notes

* chore(docs): fix imagE_registries note about pv

* chore(docs): fix typo

* chore(docs): fix version for archive on image_pruners

* chore(docs): fix version for archive on ceph_cluster

* chore(docs): rename notes to changes

* chore(docs): fix wrong sample path for csr

* chore(docs): fix version for clusterconfig/container_images

* chore(docs): missing clusteroperator config id

* chore(docs): adjust location in archive

* chore(docs): fix config_maps bp version

* chore(docs): fix release version for clusterconfig/mutating_webhook_configurations

* chore(docs): updating bp version for clusterconfig/openshift_sdn_logs

* chore(docs): update bp versions for clusterconfig/pdbs

* chore(docs): fix bp version for clusterconfig/service_accounts

* chore(docs): fix clusterconfig/validating_webhook_configurations versions

* chore(docs): rephrase changes for clusterconfig/operators_pods_and_events

* Update docs/gathered-data.md

Co-authored-by: Jan Holeček <71874510+jholecek-rh@users.noreply.github.com>

* Update docs/gathered-data.md

Co-authored-by: Jan Holeček <71874510+jholecek-rh@users.noreply.github.com>

* Update docs/gathered-data.md

Co-authored-by: Jan Holeček <71874510+jholecek-rh@users.noreply.github.com>

* chore(docs): update based on review

* chore(docs): update gathered-data

* chore(docs): update clusterconfig/machine_configs versions

* chore(docs): update clusterconfig/operators_pods_and_events

* docs(chore): fix clusterconfig/version location in archive

* chore(docs): update clusterconfig/operators

* chore(docs): document should be data oriented to conditional gathering as well

* chore(docs): update code style

---------

Co-authored-by: Jan Holeček <71874510+jholecek-rh@users.noreply.github.com>

cmd/gendoc/main.go

@@ -18,12 +18,13 @@ import (
 )
 
 var (
-	inPath     string
-	outPath    string
-	mdf        *os.File
-	randSource = rand.NewSource(time.Now().UnixNano())
-	reGather   = regexp.MustCompile(`^((Build)?Gather)(.*)`)
-	reExample  = regexp.MustCompile(`^(Example)(.*)`)
+	inPath          string
+	outPath         string
+	mdf             *os.File
+	randSource      = rand.NewSource(time.Now().UnixNano())
+	reGather        = regexp.MustCompile(`^((Build)?Gather)(.*)`)
+	reExample       = regexp.MustCompile(`^(Example)(.*)`)
+	reSampleArchive = regexp.MustCompile(`docs/(insights-archive-sample/.*)`)
 )
 
 type DocBlock struct {
@@ -50,7 +51,7 @@ func main() {
 	if err != nil {
 		fmt.Print(err)
 	}
-	// second pass will gather Sample..
+	// second pass will gather Sample...
 	err = walkDir(cleanRoot, md)
 	if err != nil {
 		fmt.Print(err)
@@ -337,7 +338,8 @@ func parseDoc(method, doc string) *DocBlock {
 		doc = strings.TrimLeft(doc, method)
 	}
 	doc = strings.TrimLeft(doc, " ")
-
+	// generates the link to the sample archive
+	doc = reSampleArchive.ReplaceAllString(doc, "[$0](./$1)")
 	db := &DocBlock{Doc: doc}
 	return db
 }