New Technical Articles guidelines

What does this MR do?

Create guidelines to new documentation guides and tutorials ("Technical Articles")

Why was this MR needed?

Establish minimum guidelines to be able to:

• Transfer blog posts currently in open MRs to documentation
• Proceed with indexes per topic
• Redact the community writers program (v2)

Todos

• Move pages guides under topics/pages/
• When https://gitlab.com/gitlab-com/www-gitlab-com/merge_requests/5361 gets merged => update link to "Writing Method"

License

• Add CC4 lincence (https://gitlab.com/gitlab-com/gitlab-docs/issues/95)
  • Add to gitlab-docs => https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/68

Does this MR meet the acceptance criteria?

• Conform by the style guides
• Branch has no merge conflicts with master (if it does - rebase it please)

What are the relevant issue numbers?

closes https://gitlab.com/gitlab-com/gitlab-docs/issues/89 closes https://gitlab.com/gitlab-com/gitlab-docs/issues/87 closes https://gitlab.com/gitlab-org/gitlab-ce/issues/29525

added 8 commits

• e4cd6c68 - add topics dir to doc_styleguide
• dda8896e - rename "documentation articles" to "technical articles"
• f6d06ad4 - rename remaining experession
• b3abbe13 - link to tech articles description
• 2edd3c0f - describes what a tech article is
• 60a09846 - add distinction between guide and tutorial
• fa079afb - add link
• c6a091d6 - grammar fix

Compare with previous version

changed title from WIP: New documentation articles guidelines to WIP: New Technical Articles guidelines

added 2 commits

• f94b6567 - add examples of guide vs tutorial
• c7b4b150 - add the "special format" to the only guide we already have in the docs

Compare with previous version

approved this merge request

assigned to @axil

mentioned in merge request gitlab-com/www-gitlab-com!5376 (merged)

added docs-priority label

mentioned in merge request gitlab-com/www-gitlab-com!4971 (closed)

mentioned in merge request !9861 (merged)

@axil How about the folder structure? Are you happy with ce/topics/topic-name? Would you prefer doing it in another way?

added 3 commits

• bbd54934 - add instructions on subtopics
• 93387599 - remove linked indexes (examples)
• e70ed3a1 - add pipeline symbols

Compare with previous version

@axil any ideas why the build is failing?

Uploading artifacts to coordinator... ok            id=12793481 responseStatus=201 Created token=29wLxUso
ERROR: Job failed: exit code 1

changed milestone to %9.1

changed milestone to %9.0

marked the task When https://gitlab.com/gitlab-com/www-gitlab-com/merge_requests/5361 gets merged => update link to "Writing Method" as completed

added 4 commits

• 38f092d1 - link to comm writers page, add what is a tech overview + example
• 6fdd595e - improve wording, update links
• d7b002f1 - add existing links to topics/index.md
• cde35cb2 - Add license to CE/doc

Compare with previous version

@axil this is the only thing I need from you to move forward here (asap): https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9984#note_26288770 😉

added 654 commits

• cde35cb2...d4c99f64 - 653 commits from branch master
• dde56f8b - Merge branch 'master' of gitlab.com:gitlab-org/gitlab-ce into new-guides-guidelines

Compare with previous version

added 1 commit

• f63bae46 - Revert "Add license to CE/doc"

Compare with previous version

I reverted the commit that added the license under /doc/

mentioned in issue gitlab-com/gitlab-docs#95 (closed)

\o/ 😃 😅 🎉

resolved all discussions

added 5 commits

• 4582f388 - fix URL
• b7690b29 - better intro to topics
• dd489351 - improve wording, move "see also" to "dev docs"
• df9fb04f - add link to "writing docs" , fix typo
• 3e5ea1cb - Merge branch 'new-guides-guidelines' of gitlab.com:gitlab-org/gitlab-ce into new-guides-guidelines

Compare with previous version

added 1 commit

• 4f9d279b - capitalization

Compare with previous version

added 1 commit

• a2f37f8b - oops - remove html element

Compare with previous version

mentioned in merge request !10299 (closed)

added 1 commit

• 0d267024 - Fix links and do some refactoring

Compare with previous version

approved this merge request

changed milestone to %9.1

unmarked as a Work In Progress

I chopped the intro a bit and moved the relevant links to the development section. Also removed the non-existing topics. Let's fill them as we go.

marked the task Branch has no merge conflicts with master (if it does - rebase it please) as completed

marked the task Conform by the style guides as completed

enabled an automatic merge when the pipeline for 0d267024 succeeds

merged

mentioned in commit b20ba361

mentioned in merge request !11045 (merged)