Te Tiro i Te Kōrero Whakataki o Tō Kaupapa i Kapsule Orbit

Ko te Docs tab e whakahua ana i te README o tō tūtukitanga i roto i KPanel, nō reira ko te whakaaturanga tāake o te kaupapa he pika mai i ōna whakatupuranga kaupapa, kaua i te tab pāpānui me pēhea te rapu a te tangata.

Ko hea te Docs Tab

Whakatukutuku Kapsule Orbit, pīkia te kaupapa, ka whiriwhiri i Docs i raro i te rōpū Overview i te rārangi tab kaupapa.

Karekau he mea hei tūtuhi. Mēnā he tūtukitanga tūhono te kaupapa me te README i tōna putake, ka whakahua te tab i tēnei.

Ko hea te Konae e Whakaatua

Ko Kapsule Orbit e tiki ana i te README mai i te peka taunoa o te tūtukitanga tūhono.

I runga i GitHub ka ngana i ētahi ingoa ōkawa i a ia: README.md, readme.md, README.MD, README, me readme.txt, me te tango i te mea tuatahi e noho ana. I runga i GitLab me Bitbucket ka rapua README.md.

Ko te putake noa o te tūtukitanga kē anake e tirotirohia. Ko te README i roto i te pouaka-iti, tae atu ki te putake pouaka-iti o te kaupapa monorepo, kāore e tīkina.

He Aha e Whakahua

Ko te README kua whakahua hei markdown: ko ngā upoko, ngā rārangi, ngā tēpu, ngā hononga, te waenga āhuatanga me ngā pouaka āhuatanga kua marara, e whakaatua katoa e pēnei ana koe e tumanako ai.

Ko ngā ara āhuatanga tāutuutu i roto i te README e tohu ana ki te tūtukitanga, ehara i KPanel, nō reira ko ngā āhuatanga ka mahi i tō tūmomo tūmomo kaupapa anō kāore pea e whakatau i konei. Mēnā he āhuatanga e whai kōrero, whakamahi i te URL pūmau.

Ngā Āhuatanga Noa

E rua ngā āhuatanga ka whakarangi i te ihirangi kāore he mea hei whakaatu:

• Karekau he tūtukitanga tūhono, me te pūtone Connect repository. Tūhono he mea tuatahi: kite Tuhunga Tūtukitanga GitHub, Tuhunga Tūtukitanga GitLab rānei Tuhunga Tūtukitanga Bitbucket.
• Karekau README i kitea, e whakatūhono ana koe ki te tāpiri i te README.md ki te putake o tō tūtukitanga, me te hononga ki te waihanga kotahi i tō tūmomo kaupapa.

Ko te rua e honohono ana ki waho ki te kaupapa kia koe ai e mahi tonu, me te āhuatanga kua whakaatua nei ka mau he hononga View on ki te konae anō mō te wā e hiahia ana koe ki te whakahou.

Te Tuhi i te README E Waiwai Kia Whakahua

I te mea ko te tab nei e noho tahi ana ki te hītori whakatupuranga, ko te README e waiwai rawa ake mō te kaupapa Kapsule Orbit he mea whakatupuranga. Ko te tangata kua whakatukutuku nā te mea kua whakawhiwhia mai i te kaupapa me te mea whakaputa.

Ko te hanga e mahi:

He aha tēnei. Kotahi whakapara. He aha te kaupapa e mahi ana me te tangata e whakahaere.

Ā te ā anō te whakatakoto. Ngā kupu tika, tae atu ki te kaitiaki pūtake. pnpm install && pnpm dev he aha noa ake i te whakapara e whāin ana i te mea kotahi.

Ngā taurangi taiao. Ko ēhea e noho ana me te mea a ia mō tōna kaupapa. Kia kore e whakaatu i ngā uara: ko aua mea nō ngā taurangi taiao o te kaupapa, ehara i te konae i te tūtukitanga. Kite Ngā Taurangi Taiao i Kapsule Orbit.

Te pokapū o te whakatupuranga. Ko ēhea te peka whakatupuranga, me te tohu ka whakatupuranga, me te puka e moe ana. Tohu ki te Kapsule Orbit Deployment Pipeline tab kaupapa kaua ko te tūtuki, i te mea kāore te tab e noho pōturi me tō README ka noho.

Te maui whakamuri. E rua ngā rerenga kupu me te hononga ki Rolling Back a Deployment. Ko tēnei te mea me rapu te tangata i te wā kino rawa, me noho i te wāhi e rapua ai rātou.

Ko wai te kaipupuri. He rōpū he tangata. Ko ngā kaupapa ka ora noa ake i te tangata i tīmata ai rātou.

Te Tāpiri i te Tohu Āhuatanga Ora

I te mea ko te README e whakahua ana i konei me i tō tūmomo kaupapa, he tohu āhuatanga whakatupuranga e waiwai ana ki te tāpiri. Ko Kapsule Orbit e whakaputa ana mo ia kaupapa.

Whakatukutuku Settings me te rapu Status badge card. E whakaatu ana i te āhuatanga ora me te toru pūtone toko: te URL tohu, te whakatapiri markdown, me te whakatapiri HTML. Whakatakoto te markdown ki te timatanga o tō README.

Ko te tohu he SVG iti e pūrongo ana i te āhuatanga nau o te kaupapa whakatupuranga: deployed, building, failed, queued, rānei no deployments. Karekau whānuitanga hiahia, nō reira ka whakahua mō ia tangata e pānui ana i te tūtukitanga, me te hononga ki te kaupapa i KPanel.

Ka hoatu tēnei he README e whakaatu, i te mea tūturu, mēnā ka ora te whakatupuranga. Ko tēnei te rārangi paetae nui rawa ake koe e tāpiri ai ki a ia.

Te Whakatika i te Pono

Ko te README e whāin ana i te whakatupu kaupapa karekau e noho nei he kino noa ake i te karekau README, nā te mea e whakapono te tangata. Ko te rua ngā āhuatanga ka whakatika i te pono:

• Hononga kaupapa kaua ko te tūtuki. Ko te mea katoa e kitea ana i KPanel, penei i ngā tūtuhi whakatipuranga, ngā puka me te whiriwhiringa taiao, me hononga, kaua ko te whakapara.
• Whakahou i te wā kotahi o te tono tūkino. Mēnā he panui ka ngaromia te pokapū o te kaupapa whakatupuranga, ko te panui README me noho i taua tono tūkino, kaua i te kōriti o muri ake.

Whakamatau Hapa

Ko te tab e whakaatu ana i te āhuatanga tawhito. Ko te cache rima meneti. Tatari me te uta anō.

Karekau README i kitea, engari kei a ia. Tirotiro kei te putake tūtukitanga me te ingoa README.md. I runga i GitLab me Bitbucket ko te ingoa me ōrite tonu.

Ko te tūtukitanga tūhono engari ko te tab e kī ana kāore. Ko te hononga pea kua ngaroa te uru, penei mēnā i tango te hononga ki te tūmomo kaupapa taha. Tūhono anō mai ngā tūtuhi kaupapa.

Kāore te āhuatanga kei te uta. Ko ngā ara āhuatanga tāutuutu kāore e whakatau i konei. Whakamahi i ngā URL pūmau.

Ko te tohu e whakaatu ana karekau whakatupuranga. Ko te taiao whakatupuranga karekau kua āra kōtahi whakatupuranga. Whakatupuranga kotahi me te whakahōu.

Ko Hea te Haere Ā Muri Ake

• Kapsule Orbit Deployment Pipeline, te āhuatanga ora o ngā mea e ngana te README ki te whāin.
• Kapsule Orbit Project Settings mō te tohu āhuatanga me te toenga o te whiriwhiringa.
• Ngā Taurangi Taiao i Kapsule Orbit mō ngā uara me te README kāore e tuku.