Како направити једноставну интерну Вики користећи Гитбоок

Како направити једноставну интерну Вики користећи Гитбоок

ГитБоок је платформа која вам омогућава да правите сајтове за документацију или вики компаније. Можете га користити за документовање свих врста ствари, од кода до АПИ-ја и како да користите софтверски производ.





ГитБоок користи сличан процес као ГитХуб репозиторијуми. Главна копија документације делује као 'главна' копија. Затим можете креирати 'нацрте', који су слични 'гранама'.





Овај процес омогућава многим корисницима да раде на једном документационом сајту док рукују или спречавају конфликте. Такође омогућава да промене из различитих грана прођу кроз процес прегледа пре него што их спојите.





Како почети да користите ГитБоок

Можете бирати између неколико ГитБоок цене планове. Цене ће зависити од тога да ли користите ГитБоок за пројекте отвореног кода, личну употребу или приватну тимску сарадњу. ГитБоок је бесплатан за коришћење ако га користите за пројекте отвореног кода.

ГитБоок подржава Маркдовн, популаран језик за означавање са многим предностима за писање или документовање на вебу.



ГитБоок се такође интегрише са ГитХуб, платформа за хостовање, складиштење и уређивање кода . Можете да повежете свој ГитБоок налог директно са својим ГитХуб налогом тако што ћете се пријавити користећи своје ГитХуб акредитиве.

  1. Пријавите се на ГитБоок. Ако имате свој ГитХуб налог, можете кликнути на Пријавите се са ГитХуб-ом .
  2. Када се пријавите, ГитБоок ће вас преусмерити на нови интерни вики. Такође ће унапред попунити ваш вики неким примером садржаја.

Преглед ГитБоок интерфејса

ГитБоок има неколико функција које вам омогућавају да направите и направите измене на вашој веб локацији за документацију.





како променити локацију резервне копије итунес -а у оперативном систему Виндовс 10
  1. Горњи панел вам омогућава да креирате нове нацрте, прегледате историју промена или прегледате било које друге дискусије или прилоге.
  2. Крајња лева бочна трака вам омогућава да креирате више простора. Можете користити одвојене просторе за различите пројекте тако да можете одвојити и организовати своје области документације. Можете проширити или затворити бочну траку.
  3. Лева табла служи као мени за локацију за документацију. Можете да прегледате странице у оквиру свог сајта за документацију и да га користите за креирање група и угнежђених страница. Такође можете да се крећете по сајту користећи дате везе.
  4. Доња табла садржи дугмад која су од виталног значаја за процес контроле верзија. Можете да додате назив за радну верзију, спојите измену или пошаљете промену на преглед.

Како направити нови нацрт

Можете креирати нови нацрт тако што ћете креирати нови захтев за промену и уносити измене унутар њега.

  1. У горњем панелу кликните на Захтеви за промену .
  2. На новом панелу који се појављује на десној страни кликните на Нацрт таб. Ово ће вам показати све ваше активне нацрте.
  3. Одавде можете кликнути на постојећу нацрт да бисте је отворили. Да бисте креирали нови нацрт, кликните на Захтев за нову промену , и сачекајте да се страница заврши учитавањем.
  4. У доњем панелу кликните на Унесите предмет . Ово ће отворити прозор у којем новом нацрту можете дати име. На пример, Нова страница - Како да подесите кодну базу .

Како да креирате странице и групе

Када добијете нацрт, можете почети да уносите измене у документацију. ГитБоок чува ваше измене у нацрту, тако да не утичу на главну копију. Можете користити леву бочну траку да додате странице и групе страница.





  1. Креирајте нову страницу кликом на Нова страница везу на дну бочне траке и изаберите Нова страница документа из падајућег менија. Алтернативно, можете да задржите показивач испод постојеће странице и кликнете на плаво плус дугме.
  2. Да бисте креирали нову групу страница, кликните на Нова страница и изаберите Нова група опција из падајућег менија.
  3. Страницу можете преименовати тако што ћете кликнути на три тачке поред странице или групе и изабрати Преименуј .
  4. Почните да додајете садржај да бисте попунили своју нову страницу. Можете додати једноставан садржај као што су текст или наслови. ГитБоок вам такође омогућава да додате друге блокове садржаја као што су слике, прилози датотека, табеле, картице или исечци кода. Постоји и опција за додавање других интеграција као што су ИоуТубе уградње или садржај Гоогле докумената.
  5. Кликните на Дифф виев дугме у доњем панелу да видите разлике између ваше радне верзије и оригиналне копије главне документације.
  6. Када завршите са писањем садржаја, можете кликнути на Споји , Пошаљите и спојите , или Пошаљите на преглед .

Можете приступити линку за дељење са горњег панела ГитБоок-а. Мораћете да будете ван нацрта и да прегледате копију главне документације да бисте могли да видите везу.

  1. Подразумевано, видљивост вашег сајта за документацију је „ненаведена“. То значи да сајту за документацију можете приступити користећи приватну везу, а не преко претраживача. У горњем панелу кликните на Ненаведено дугме.
  2. Изаберите жељена подешавања видљивости из падајућег менија. Имајте на уму да ГитБоок може закључати одређена подешавања видљивости и можда ћете морати да надоградите да бисте им приступили.
  3. Испод листе подешавања видљивости налази се веза коју можете да делите са другим корисницима који ће користити вашу веб локацију за документацију. Копирајте ову везу да бисте је поделили са другима.
  4. Испод везе кликните на Подешавања везе и домена . Овде можете да повежете прилагођено име домена или да измените део УРЛ-а. Ако користите прилагођени домен, можете да видите Гитбоок-ова документација о томе како да правилно конфигуришете свој ДНС.

Креирање документације помоћу ГитБоок-а

ГитБоок вам омогућава да заједно креирате и радите на документационим сајтовима или викијима компаније. ГитБоок позајмљује концепте од ГитХуб-а као што су гране и спајање да би контролисао главну копију и управљао свим конфликтима.

Можете да направите нови нацрт да бисте додали сопствене појединачне измене у документацију. У оквиру нацрта можете да уносите измене у садржај, као и да додајете нове странице или групе страница. Када завршите са уносом измена, можете их спојити или послати на преглед.

Ако креирате интерну документацију за свој Јава код, можда ћете желети да истражите Јавадоц. Јавадоц вам омогућава да аутоматски документујете свој Јава код.