Merge pull request #4818 from adamdmharvey/refactor-techdocs-logging

chore(techdocs-common, techdocs-backend): Refactor TechDocs logging

packages/techdocs-common/src/helpers.ts

@@ -216,12 +216,12 @@ export const getDocFilesFromRepository = async (
     entity,
   );
 
-  opts?.logger?.info(`Reading files from ${target}`);
+  opts?.logger?.debug(`Reading files from ${target}`);
   // readTree will throw NotModifiedError if etag has not changed.
   const readTreeResponse = await reader.readTree(target, { etag: opts?.etag });
   const preparedDir = await readTreeResponse.dir();
 
-  opts?.logger?.info(`Tree downloaded and stored at ${preparedDir}`);
+  opts?.logger?.debug(`Tree downloaded and stored at ${preparedDir}`);
 
   return {
     preparedDir,

packages/techdocs-common/src/stages/generate/helpers.ts

@@ -252,7 +252,7 @@ export const patchMkdocsYmlPreBuild = async (
     mkdocsYmlFileString = await fs.readFile(mkdocsYmlPath, 'utf8');
   } catch (error) {
     logger.warn(
-      `Could not read file ${mkdocsYmlPath} before running the generator. ${error.message}`,
+      `Could not read MkDocs YAML config file ${mkdocsYmlPath} before running the generator: ${error.message}`,
     );
     return;
   }