https://docs.ignite.com/assets/js/24d14d19.760076da.js

1"use strict";(globalThis.webpackChunkmy_website=globalThis.webpackChunkmy_website||[]).push([[2262],{15680(e,t,n){n.d(t,{xA:()=>g,yg:()=>d});var r=n(96540);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function a(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?o(Object(n),!0).forEach((function(t){i(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):o(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function l(e,t){if(null==e)return{};var n,r,i=function(e,t){if(null==e)return{};var n,r,i={},o=Object.keys(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r<o.length;r++)n=o[r],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=r.createContext({}),u=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):a(a({},t),e)),n},g=function(e){var t=u(e.components);return r.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},p=r.forwardRef((function(e,t){var n=e.components,i=e.mdxType,o=e.originalType,s=e.parentName,g=l(e,["components","mdxType","originalType","parentName"]),p=u(n),d=i,h=p["".concat(s,".").concat(d)]||p[d]||c[d]||o;return n?r.createElement(h,a(a({ref:t},g),{},{components:n})):r.createElement(h,a({ref:t},g))}));function d(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var o=n.length,a=new Array(o);a[0]=p;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l.mdxType="string"==typeof e?e:i,a[1]=l;for(var u=2;u<o;u++)a[u]=n[u];return r.createElement.apply(null,a)}return r.createElement.apply(null,n)}p.displayName="MDXCreateElement"},57990(e,t,n){n.r(t),n.d(t,{assets:()=>s,contentTitle:()=>a,default:()=>c,frontMatter:()=>o,metadata:()=>l,toc:()=>u});var r=n(58168),i=(n(96540),n(15680));const o={sidebar_position:1,slug:"/contributing"},a="Improving documentation",l={unversionedId:"contributing/docs",id:"contributing/docs",title:"Improving documentation",description:"Thank you for visiting our repository and considering making contributions. We",source:"@site/docs/05-contributing/01-docs.md",sourceDirName:"05-contributing",slug:"/contributing",permalink:"/nightly/contributing",draft:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{sidebar_position:1,slug:"/contributing"},sidebar:"tutorialSidebar",previous:{title:"Vue frontend",permalink:"/nightly/clients/vue"},next:{title:"Migration Guides",permalink:"/nightly/migration/"}},s={},u=[{value:"Using this repo",id:"using-this-repo",level:2},{value:"Reviewing technical content PRs",id:"reviewing-technical-content-prs",level:2},{value:"Writing and contributing",id:"writing-and-contributing",level:2},{value:"Where can I find the tutorials and docs?",id:"where-can-i-find-the-tutorials-and-docs",level:2},{value:"Who works on the tutorials?",id:"who-works-on-the-tutorials",level:2},{value:"Viewing docs builds",id:"viewing-docs-builds",level:2}],g={toc:u};function c(e){let{components:t,...n}=e;return(0,i.yg)("wrapper",(0,r.A)({},g,n,{components:t,mdxType:"MDXLayout"}),(0,i.yg)("h1",{id:"improving-documentation"},"Improving documentation"),(0,i.yg)("p",null,"Thank you for visiting our repository and considering making contributions. We\nappreciate your interest in helping us to create and maintain awesome tutorials\nand documentation."),(0,i.yg)("h2",{id:"using-this-repo"},"Using this repo"),(0,i.yg)("p",null,"Review existing ",(0,i.yg)("a",{parentName:"p",href:"https://github.com/ignite/cli/issues"},"IGNITE\xae CLI issues")," to see\nif your question has already been asked and answered."),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"To provide feedback, file an issue and provide generous details to help us\nunderstand how we 

1can make it better."),(0,i.yg)("li",{parentName:"ul"},"To provide a fix, make a direct contribution. If you're not a member or\nmaintainer, fork the repo and then submit a pull request (PR) from your forked\nrepo to the ",(0,i.yg)("inlineCode",{parentName:"li"},"main")," branch."),(0,i.yg)("li",{parentName:"ul"},"Start by creating a draft pull request. Create your draft PR early, even if\nyour work is just beginning or incomplete. Your draft PR indicates to the\ncommunity that you're working on something and provides a space for\nconversations early in the development process. Merging is blocked for ",(0,i.yg)("inlineCode",{parentName:"li"},"Draft"),"\nPRs, so they provide a safe place to experiment and invite comments.")),(0,i.yg)("h2",{id:"reviewing-technical-content-prs"},"Reviewing technical content PRs"),(0,i.yg)("p",null,"Some of the best content contributions come during the PR review cycles. Follow\nbest practices for technical content PR reviews just like you do for code\nreviews."),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"For in-line suggestions, use the ",(0,i.yg)("a",{parentName:"li",href:"https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request"},"GitHub suggesting\nfeature"),"\n."),(0,i.yg)("li",{parentName:"ul"},"The PR owner can merge in your suggested commits one at a time or in batch\n(preferred)."),(0,i.yg)("li",{parentName:"ul"},"When you are providing a more granular extensive review that results in more\nthan 20 in-line suggestions, go ahead and check out the branch and make the\nchanges yourself.")),(0,i.yg)("h2",{id:"writing-and-contributing"},"Writing and contributing"),(0,i.yg)("p",null,"We welcome contributions to the docs and tutorials."),(0,i.yg)("p",null,"Our technical content follows the ",(0,i.yg)("a",{parentName:"p",href:"https://developers.google.com/style"},"Google developer documentation style\nguide"),". Highlights to help you get started:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://developers.google.com/style/highlights"},"Highlights")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://developers.google.com/style/word-list"},"Word list")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://developers.google.com/style/tone"},"Style and tone")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://developers.google.com/style/translation"},"Writing for a global\naudience")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://developers.google.com/style/cross-references"},"Cross-references")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://developers.google.com/style/tense"},"Present tense"))),(0,i.yg)("p",null,"The Google guidelines include more material than is listed here and are used as\na guide that enables easy decision-making about proposed content changes."),(0,i.yg)("p",null,"Other useful resources:"),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://developers.google.com/tech-writing"},"Google Technical Writing Courses")),(0,i.yg)("li",{parentName:"ul"},(0,i.yg)("a",{parentName:"li",href:"https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax"},"GitHub Guides Mastering\nMarkdown"))),(0,i.yg)("h2",{id:"where-can-i-find-the-tutorials-and-docs"},"Where can I find the tutorials and docs?"),(0,i.yg)("p",null,"Technical content includes knowledge base articles and interactive tutorials."),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"The IGNITE\xae CLI Developer Tutorials content is in the ",(0,i.yg)("inlineCode",{parentName:"li"},"docs/guide")," folder."),(0,i.yg)("li",{parentName:"ul"},"The Knowledge Base content is in the ",(0,i.yg)("inlineCode",{parentName:"li"},"docs/kb")," folder."),(0,i.yg)("li",{parentName:"ul"},"Upgrade information is in the ",(0,i.yg)("inlineCode",{parentName:"li"},"docs/migration")," folder.")),(0,i.yg)("p",null,"Note: The CLI docs are auto-generated and do not support doc updates."),(0,i.yg)("p",null,"Locations and folders for other content can vary. Explore the self-describing\nfolders for the content that you are interested in. Some articles and tutorials\nreside in a single Markdown file while sub-folders might be present for other\ntutorials."),

1(0,i.yg)("p",null,"As always, work-in-progress content might be happening in other locations and\nrepos."),(0,i.yg)("h2",{id:"who-works-on-the-tutorials"},"Who works on the tutorials?"),(0,i.yg)("p",null,"The IGNITE\xae product team developers are focused on building IGNITE\xae CLI and\nimproving the developer experience. The IGNITE\xae Ecosystem Development team owns\nthe technical content and tutorials and manages developer onboarding."),(0,i.yg)("p",null,"Meet the ",(0,i.yg)("a",{parentName:"p",href:"https://github.com/ignite/cli/graphs/contributors"},"people behind IGNITE\xae CLI and our\ncontributors"),"."),(0,i.yg)("h2",{id:"viewing-docs-builds"},"Viewing docs builds"),(0,i.yg)("p",null,"Use a preview to see what your changes will look like in production before the\nupdated pages are published."),(0,i.yg)("ul",null,(0,i.yg)("li",{parentName:"ul"},"While a PR is in draft mode, you can rely on using the preview feature in\nMarkdown."),(0,i.yg)("li",{parentName:"ul"},"After the PR moves from ",(0,i.yg)("strong",{parentName:"li"},"Draft")," to ",(0,i.yg)("strong",{parentName:"li"},"Ready for review"),", the CI status\nchecks generate a deployment preview. This preview stays up to date as you\ncontinue to work and commit new changes to the same branch. A ",(0,i.yg)("inlineCode",{parentName:"li"},"Docs Deploy\nPreview / build_and_deploy (pull_request)")," preview on a GitHub actions URL is\nunique for that PR.")))}c.isMDXComponent=!0}}]);