*/README.md: logical headings

start a doc on h1 heading

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>

docs/developers/README.md

@@ -1,9 +1,9 @@
-## Developer docs
+# Developer docs
 
 This document is aimed at helping maintainers/developers of project understand
 the complexity.
 
-### How are resources shared between tasks?
+## How are resources shared between tasks?
 
 `PipelineRun` uses PVC to share resources between tasks. PVC volume is mounted
 on path `/pvc` by PipelineRun.
@@ -33,15 +33,15 @@ creation of a persistent volume could be slower than uploading/downloading files
 to a bucket, or if the the cluster is running in multiple zones, the access to
 the persistent volume can fail.
 
-### How are inputs handled?
+## How are inputs handled?
 
 Input resources, like source code (git) or artifacts, are dumped at path
 `/workspace/task_resource_name`. Resource definition in task can have custom
 target directory. If `targetPath` is mentioned in task input then the
 controllers are responsible for adding container definitions to create
 directories and also to fetch the versioned artifacts into that directory.
 
-### How are outputs handled?
+## How are outputs handled?
 
 Output resources, like source code (git) or artifacts (storage resource), are
 expected in directory path `/workspace/output/resource_name`.

test/logs/README.md

@@ -1,4 +1,4 @@
-## How to follow log outputs?
+# How to follow log outputs?
 
 - [How to follow PipelineRun logs?](#pipelinerun)
 - [How to follow TaskRun logs?](#taskrun)
@@ -16,7 +16,7 @@ logs will return error `Unable to retrieve container logs`.
 go run test/logs/main.go [-n NAMESPACE] [-pr PIPELINERUN-NAME] / [-tr TASKRUN_NAME] [-f FILE-NAME]
 ```
 
-### General flags
+## General flags
 
 ```shell
 -n string
@@ -29,7 +29,7 @@ Command provides option to change namespace with `-n` flag. If user wants to
 dump logs to a file then `-f` flag could be used. By default logs are dumped to
 `stdout`.
 
-### PipelineRun
+## PipelineRun
 
 The following command will tail logs for all `Taskruns` created by pipelinerun
 `my-pr` in namespace `default`.
@@ -38,7 +38,7 @@ The following command will tail logs for all `Taskruns` created by pipelinerun
 go run test/logs/main.go -pr my-pr
 ```
 
-### TaskRun
+## TaskRun
 
 The following command will tail logs for all specified `Taskrun` in namespace
 `default`.