Välkommen till AI Öst Teknik gruppens dokumentationsrepository. Här samlar vi alla dokument och filer som vi samarbetar kring.
Vi uppmuntrar nykomlingar att gå med i vår community. Det finns två sätt att göra detta:
- Begär att bli medlem på AI Öst GitHub.
- Eller hitta oss på My AI.
Syftet med detta repository är att tillhandahålla en central plats där alla medlemmar i AI Öst Teknik gruppen kan skapa, redigera och samarbeta kring dokument. Detta inkluderar tekniska specifikationer, mötesanteckningar, projektplaner och andra viktiga filer.
För att lägga till eller redigera dokument, följ dessa steg:
-
Klona repositoryt:
git clone https://github.com/ai-ost/docs.git cd docs
-
Skapa en ny fil eller redigera en befintlig:
- För att skapa en ny fil, lägg till din fil i mappen
_files
och ge den ett relevant namn, exempelvisditt-dokument.md
. - För att redigera en befintlig fil, öppna den filen du vill redigera i en texteditor och gör dina ändringar.
- För att skapa en ny fil, lägg till din fil i mappen
-
Lägg till och committa dina ändringar:
git add . git commit -m "Lägg till eller beskriv dina ändringar"
-
Push dina ändringar till GitHub:
git push origin main
-
Navigera till repositoryt: Gå till https://github.com/ai-ost/docs på GitHub.
-
Öppna filen du vill redigera: Klicka på mappen
_files
och sedan på filen du vill redigera. -
Redigera filen: Klicka på ikonen med en penna (✏️) längst upp till höger på filens visningssida för att börja redigera filen.
-
Spara dina ändringar: När du har gjort dina ändringar, scrolla ner till botten av sidan. Skriv en kort beskrivning av vad du har ändrat i fältet "Commit changes". Välj alternativet "Commit directly to the
main
branch" och klicka sedan på "Commit changes".
Om du vill göra ändringar som påverkar hela repositoryt, såsom att ändra Jekyll-tema, lägga till nya samlingar (collections), eller börja blogga, är detta helt okej men bör godkännas av andra medlemmar i communityn. Följ dessa steg:
-
Diskutera ändringen: Starta en diskussion med de andra medlemmarna i repositoryt. Detta kan göras genom att skapa en issue eller genom att använda ett annat kommunikationssätt som gruppen föredrar.
-
Beskriv ändringen: Förklara varför ändringen behövs och hur den kommer att genomföras. Om möjligt, ge exempel eller skisser för att bättre illustrera din idé.
-
Få godkännande: Se till att få godkännande från andra medlemmar innan du genomför större ändringar. Detta hjälper till att säkerställa att alla är överens och att inga oväntade problem uppstår.
-
Genomför ändringen: Efter att ha fått godkännande, genomför ändringen enligt överenskommelsen. Dokumentera gärna ändringen och dess påverkan i repositoryt för framtida referens.
Genom att följa dessa steg kan vi säkerställa att alla större ändringar görs på ett organiserat och samarbetsinriktat sätt.
Här är några användbara länkar som kan hjälpa dig att komma igång:
- GitHub Pages - Dokumentation för GitHub Pages
- Architect-tema - GitHub Pages Architect-tema
- Markdown Syntax - Guide till grundläggande Markdown-syntax
- Jekyll - Dokumentation för Jekyll, motoren bakom GitHub Pages
Om du har några frågor eller behöver hjälp, tveka inte att kontakta någon av administratörerna för detta repository.
Tack för ditt bidrag till AI Öst Teknik gruppens dokumentationsrepository!