Review available documentation about job logs

Problem to solve

Following !160036 (merged), we realized we probably need to review all the docs we have about job logs and make sure they are documented in the same place. We should consider creating a dedicated page for job logs. In this page, we should think about whether we want to also contain docs about the following, or crosslink:

• Troubleshooting failed jobs (which you see when viewing the job log)
• Formatting script output (which affects how they display job logs)
• ?

Further details

I used grep in GitLab and GitLab Runner doc/ and docs/ directories respectively to search for topics with the term job logs in it.

The following should be kept where they're right now because it's platform specific troubleshooting info.

• doc//install/aws/index.md:### Some job logs are not uploaded to object storage
• doc//integration/jenkins.md:### Enable job logs in Jenkins
• docs//install/windows.md:### Blank lines for Windows Subsystem for Linux (WSL) STDOUT output in job logs

I also left these topics as is:

• doc//administration/cicd/job_artifacts_troubleshooting.md:#### Delete old job logs and artifacts for a project
• doc//administration/cicd/job_artifacts_troubleshooting.md:#### Delete old job logs and artifacts instance wide

I added links to these topics in the Job logs and Jobs pages:

• doc//ci/yaml/script.md:## Expand and collapse job log sections
• doc//user/storage_management_automation.md:### Delete job logs
• doc//administration/instance_limits.md:### Maximum file size for job logs

Proposal

Discuss with Dev/Marcel if we have more troubleshooting info, and add them in the Job logs page.

Who can address the issue

Other links/references

changed milestone to %Backlog

added Technical Writing devopsverify docsimprovement documentation grouppipeline execution typemaintenance labels

assigned to @marcel.amirault

added sectionci label

added TW-DRIMarcel label

FYI @waldyrious, I created this issue so I don't forget

cc @lyspin @rsarangadharan

@rsarangadharan If you are still OK with helping out on this one, let me know and I'll assign this issue to you instead.

Sure, @marcel.amirault.

mentioned in issue gitlab-org/quality/triage-reports#18921 (closed)

added Category:Continuous Integration label

removed TW-DRIMarcel label

assigned to @rsarangadharan and unassigned @marcel.amirault

mentioned in merge request !169893 (merged)

changed the description

mentioned in merge request !170432 (merged)

Resolved with !170432 (merged), so I'll close this issue

cc @rsarangadharan

closed

changed milestone to %17.6

marked this issue as related to technical-writing#1107

mentioned in merge request gitlab-docs!5166 (merged)