Conceptual article template

Use the content model for full instructions and examples on how to write conceptual content. For more information, seeConceptual content type.

---title:'About <subject>'shortTitle:'<subject>'intro:'Article intro. See tips for a great intro below.'product:"optional product callout"type:overviewtopics:-topicversions:-version---{%comment%}-Followtheguidelinesinhttps://docs.github.com/contributing/writing-for-github-docs/content-model#conceptualtowritethisarticle.-Greatintrosgivereadersaquickunderstandingofwhat'sinthearticle,sotheycantellwhetherit'srelevanttothembeforemovingahead.Formoretips,seehttps://docs.github.com/contributing/writing-for-github-docs/content-model-Forproductcalloutinfo,seehttps://github.com/github/docs/tree/main/content#product-Forproductversioninstructions,seehttps://github.com/github/docs/tree/main/content#versioning-Removethesecommentsfromyourarticlefilewhenyou'redonewriting.{%endcomment%}## A section here{%comment%}Writeoneortwoparagraphsaboutthemainideaofyourtopic,asasummary.Makesureyoudon'thaveanycontentthatisn'tprecededbyaheader,oritwon'tbelinkableinourtableofcontents.{%endcomment%}## Another section here{%comment%}Writeoneortwoparagraphsaboutanotherelementofyourtopic.Keepaddingheadersandsectionsuntilyou'vecompletedyourarticle.{%endcomment%}## Further reading{%comment%}Optionally,includeabulletedlistofrelatedarticlestheusercanreferencetoextendtheconceptscoveredinthisarticle.Considerlinkingtoproceduralarticlesortutorialsthathelptheuserusetheinformationinyourarticle.{%endcomment%}- [Articletitle](article-URL)

Referential article template

Use the content model for full instructions and examples on how to write referential content. For more information, seeReferential content type.

---title:NounsdescribingyoursubjectshortTitle:<subject># Max 31 charactersintro:'Article intro. See tips for a great intro below.'product:"{{ optional product callout }}"type:referencetopics:-<topic># One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.jsversions:-<version>---{%comment%}Followtheguidelinesinhttps://docs.github.com/contributing/writing-for-github-docs/content-model#referentialtowritethisarticle.-->Greatintrosgivereadersaquickunderstandingofwhat'sinthearticle,sotheycantellwhetherit'srelevanttothembeforemovingahead.Formoretips,seehttps://docs.github.com/contributing/writing-for-github-docs/content-modelForproductcalloutinfo,seehttps://github.com/github/docs/tree/main/content#productForproductversioninstructions,seehttps://github.com/github/docs/tree/main/content#versioningRemovethesecommentsfromyourarticlefilewhenyou'redonewriting{%endcomment%}## A section here{%comment%}Writeoneortwoparagraphsaboutthemainideaofyourtopic,asasummary.Makesureyoudon'thaveanycontentthatisn'tprecededbyaheader,oritwon'tbelinkableinourtableofcontents.{%endcomment%}## Another section here{%comment%}Writeoneortwoparagraphsaboutanotherelementofyourtopic.Keepaddingheadersandsectionsuntilyou'vecompletedyourarticle.{%endcomment%}## Further reading{%comment%}Optionally,includeabulletedlistofrelatedarticlestheusercanreferencetoextendtheconceptscoveredinthisarticle.Considerlinkingtoproceduralarticlesortutorialsthathelptheuserusetheinformationinyourarticle.{%endcomment%}- [Articletitle](article-URL)

Procedural article template

Use the content model for full instructions and examples on how to write procedural content. For more information, seeProcedural content type.

---title:StartwithapresentparticipleshortTitle:<subject># Max 31 charactersintro:'Article intro. See tips for a great intro below.'product:"{{ optional product callout }}"type:how_totopics:-<topic># One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.jsversions:-<version>---{%comment%}Followtheguidelinesinhttps://docs.github.com/contributing/writing-for-github-docs/content-model#proceduraltowritethisarticle.-->Greatintrosgivereadersaquickunderstandingofwhat'sinthearticle,sotheycantellwhetherit'srelevanttothembeforemovingahead.Formoretips,seehttps://docs.github.com/contributing/writing-for-github-docs/content-modelForproductcalloutinfo,seehttps://github.com/github/docs/tree/main/content#productForproductversioninstructions,seehttps://github.com/github/docs/tree/main/content#versioningRemovethesecommentsfromyourarticlefilewhenyou'redonewriting{%endcomment%}## Procedural section header here{%comment%}Includeprerequisiteinformationorspecificpermissionsinformationhere.Thenwriteproceduralstepsfollowingtheinstructionsinhttps://docs.github.com/contributing/style-guide-and-content-model/style-guide#procedural-steps.Checkifthere'salreadyareusablestringforthestepyouwanttowriteinhttps://github.com/github/docs/tree/main/data/reusables.Lookatthesourcefileforaprocedurelocatedinthesameareaoftheuserinterfacetofindreusables.{%endcomment%}## Optionally, another procedural section here{%comment%}Keepaddingproceduresuntilyou'vefinishedwritingyourarticle.{%endcomment%}## Further reading{%comment%}Optionally,includeabulletedlistofrelatedarticlestheusercanreferencetoextendtheconceptscoveredinthisarticle.Considerlinkingtoproceduralarticlesortutorialsthathelptheuserusetheinformationinyourarticle.{%endcomment%}- [Articletitle](article-URL)

Quickstart article template

Use the content model for full instructions and examples on how to write quickstarts. For more information, seeQuickstart content type.

---title:QuickstarttitleshortTitle:<subject># Max 31 charactersintro:'Article intro. Highlight that the guide is quick and to the point.'type:quick_starttopics:-<topic># One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.jsversions:-<version>---{%comment%}Followtheguidelinesinhttps://docs.github.com/contributing/writing-for-github-docs/content-model#quickstarttowritethisarticle.Forproductversioninstructions,seehttps://github.com/github/docs/tree/main/content#versions.Theentirequickstartshouldbeabout600wordslongortakeaboutfiveminutestoread.Removethesecommentsfromyourarticlefilewhenyou'redonewriting{%endcomment%}## Introduction{%comment%}Buildonthequickphrasingaboveby-Clarifyingtheaudience-Clearlystatingprerequisitesandpriorknowledgeneeded-Statingwhattheuserwillaccomplishorbuild{%endcomment%}## Step one: Action the user will take{%comment%}Inonesentence,describewhattheuserwilldointhisstepStepsshouldbreakdownthetaskstheuserwillcompleteinsequentialorderAvoidreplicatingconceptualinformationthatiscoveredelsewhere,provideinlinelinksinstead.Onlyincludeconceptualinformationuniquetothisusecase.{%endcomment%}### Task chunk{%comment%}Astepmayrequiretheusertoperformseveraltasks-breakthosetasksdownintochunks,allowingtheusertoscanquicklytofindtheirplaceiftheynavigatedawayfromthisscreentoperformthetask.AnexamplemightbecreatingapersonalaccesstokenfortheactiontouseandthenstoringitinsecretsForUIbasedtasks,includethebuttonoroptionstheusersshouldclickIfthetaskaddscode,includethecodeincontext(don'tjustshow`needssetup`showtheentire`setup`and`dependent`jobs){%endcomment%}### Another task chunk## Step 2: Do the next thing{%comment%}Rinseandrepeat,addingstepsandtasksuntilthetutorialiscomplete{%endcomment%}## Next steps{%comment%}Provideaquickrecapofwhathasbeenaccomplishedinthequickstartasameansoftransitioningtonextsteps.Include2-3actionablenextstepsthattheusertakeaftercompletingthequickstart.Alwayslinktoconceptualcontentonthefeatureorproduct.Youcanalsolinkofftootherrelatedinformationondocs.github.comorinGitHubSkills.{%endcomment%}

Tutorial article template

Use the content model for full instructions and examples on how to write tutorials. For more information, seeTutorial content type.

---title:TutorialtitleshortTitle:<subject># Max 31 charactersintro:'Article intro. See tips for a great intro below'product:"{{ optional product callout }}"type:tutorialtopics:-<topic># One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.jsversions:-<version>---{%comment%}Followtheinstructionsinhttps://docs.github.com/contributing/writing-for-github-docs/content-model#quickstarttowritethisarticle.Greatintrosclarifywhothetutorialisintendedfor,statewhattheuserwillaccomplish,andstatethetechnologiesthatwillbeused.Forproductcalloutinfo,seehttps://github.com/github/docs/tree/main/content#productForproductversioninstructions,seehttps://github.com/github/docs/tree/main/content#versioningRemovethesecommentsfromyourarticlefilewhenyou'redonewriting{%endcomment%}## Introduction{%comment%}Thetutorialintroductionshouldincludethefollowinginashortparagraph--Clarifyaudience-Stateprerequisitesandpriorknowledgeneeded-Statewhattheuserwillaccomplishorbuildandtheuserproblemitsolves-Linktoanexampleoftheprojecttheuserwillcomplete{%endcomment%}## Step 1: Action the user will take{%comment%}Inonesentence,describewhattheuserwilldointhisstepStepsshouldbreakdownthetaskstheuserwillcompleteinsequentialorderAvoidreplicatingconceptualinformationthatiscoveredelsewhere,provideinlinelinksinstead.Onlyincludeconceptualinformationuniquetothisusecase.{%endcomment%}### Task chunk{%comment%}Astepmayrequiretheusertoperformseveraltasks-breakthosetasksdownintochunks,allowingtheusertoscanquicklytofindtheirplaceiftheynavigatedawayfromthisscreentoperformthetask.AnexamplemightbecreatingapersonalaccesstokenfortheactiontouseandthenstoringitinsecretsForUIbasedtasks,includethebuttonoroptionstheusersshouldclickIfthetaskaddscode,includethecodeincontext(don'tjustshow`needs:setup`showtheentire`setup`and`dependent`jobs){%endcomment%}### Another task chunk## Step 2: Do the next thing{%comment%}Rinseandrepeat,addingstepsandtasksuntilthetutorialiscompleteRemembertoshowcodesnippetsincontext{%endcomment%}## Further reading{%comment%}Includeabulletedlistoftutorialsorarticlestheusercanreferencetoextendtheconceptstaughtinthistutorial{%endcomment%}- [Articletitle](article-URL)

Language guides for GitHub Actions

Use the content model for full instructions and examples on how to write for GitHub Docs. For more information, seeAbout the content model.

---title:GuidetitleshortTitle:<subject># Max 31 charactersintro:'Article intro. See tips for a great intro below'product:"{{ optional product callout }}"type:tutorialtopics:-<topic># One or more from list of allowed topics: https://github.com/github/docs/blob/main/data/allowed-topics.jsversions:-<version>---{%comment%}-Greatintrosclarifywhotheguideisintendedfor,statewhattheuserwillaccomplish,andstatethetechnologiesthatwillbeused.-Introsaretypically1-3sentencesummaries,withalonger"Introduction"sectionthatfollows.-Removethesecommentsfromyourarticlefilewhenyou'redonewriting{%endcomment%}## Introduction{%comment%}Thelanguageguideintroductionshouldincludethefollowinginashortparagraph--Clarifyaudience.-Stateprerequisitesandpriorknowledgeneeded.-Shouldtheuserhavereadanyotherarticles?-Statewhattheuserwillaccomplishorbuildandtheuserproblemitsolves.{%endcomment%}## Starting with the <language> workflow template{%comment%}Languageguidestypicallywalkthroughandbuilduponaworkflowtemplate.Ifthatformatdoesn'twork,youcanincludeaboilerplateworkflow.-LinktotheGitHubActionsCIworkflowtemplateastheboilerplatereferencecodeandthenwalkthroughandbuildonthatcodeinthisguide-https://github.com/actions/starter-workflows/tree/master/ci-Provideinstructionsforaddingtheworkflowtemplatetoarepository.-Includethestartertemplateworkflowcode.{%endcomment%}## Running on different operating systems{%comment%}Includeabriefoverviewofhowtochoosetherunnerenvironment.Theseshouldbealternativestowhatoperatingsystemispresentedintheworkflowtemplate/boilerplatetemplate.{%endcomment%}## Configuring the <language> version{%comment%}-Describewhenandhowtouseavailablesetupactionsthatconfiguretheversionofthelanguageontherunner(ex.actions/setup-node).-Howdoesthesetupactionconfiguretheversionandwhathappenswhentheversionisn'tsupportedintheenvironment.Whatisthedefaultversion,whennoversionisconfigured.-IncludeanyadditionalfeaturesthesetupactionmightprovidethatareusefultoCI.-Ifapplicable,provideexamplesofconfiguringexactversionsormajor/minorversions.-IncludeinformationaboutsoftwarealreadyinstalledonGitHub-hostedrunnersorsoftwareconfigurationnecessarytobuildandtesttheproject.-Provideexamplesofconfiguringmatrixstrategies.-LinkouttoanydocsaboutavailablesoftwareontheGitHub-hostedrunners.(Ex.https://docs.github.com/en/actions/reference/software-installed-on-github-hosted-runners).-Includecodesamples.{%endcomment%}## Installing dependencies{%comment%}-Includeexampleofinstallingdependenciestoprepareforbuildingandtesting.-Arethereanydependenciesorscenarioswherepeoplemightneedtoinstallpackagesglobally?-Includeexamplesofcommonpackagemanagers.-IfthelanguageissupportedbyGitHubPackages,includeanexampleinstallingdependenciesfromGitHub.-Includecodesamples.{%endcomment%}## Caching dependencies{%comment%}Includeanexampleofrestoringcacheddependencies.We'llwanttolinkouttothearticleaboutcachingformoreinformation(https://docs.github.com/en/actions/configuring-and-managing-workflows/caching-dependencies-to-speed-up-workflows).{%endcomment%}## Building your code{%comment%}-Includeanycompilesteps.-Includeanytestcommands.-Notethatyoucanusethesamecommandsthatyourrepositoryneedstobuildandtestyourcodebysimplyreplacingthecommandsinthe`run`keyword.-Includeanybasicexamplesorcommandsspecifictotestframeworks.-Includeanycommondatabasesorservicesthatmightbeneeded.Ifso,wecanlinkouttotheservicesguidesinthedocs(https://docs.github.com/en/actions/configuring-and-managing-workflows/using-databases-and-service-containers).{%endcomment%}## Packaging workflow data as artifacts{%comment%}Thissectioncansimplylinkouttohttps://docs.github.com/en/actions/configuring-and-managing-workflows/persisting-workflow-data-using-artifactsorprovideadditionalinformationaboutwhichartifactsmightbetypicaltouploadforaCIworkflow.{%endcomment%}