2. Project management¶
This week I worked on defining my final project idea and getting used to the documentation process using GitLab and MkDocs.
Steps to Set Up GitLab with SSH and MkDocs¶
Below are the steps I followed to connect my local environment to GitLab using SSH keys and initialize MkDocs for project documentation.
In the terminal, I ran the following command to generate an SSH key:
ssh-keygen -t ed25519 -C "your_email@example.com"
I then added the public key to my GitLab account under Settings → SSH Keys. Adding SSH Key to GitLab
2. Clone the Repository¶
After setting up the SSH connection, I cloned my project from GitLab using:
git clone git@gitlab.fabcloud.org:your-repository.git
3. Install MkDocs¶
To create a documentation site, I installed MkDocs using pip:
pip3 install mkdocs
4. Create the Documentation Structure¶
To initialize MkDocs, I used the following command:
mkdocs new docs
5. Build and Serve the Documentation¶
To preview the site locally, I ran:
mkdocs serve
6. Push Changes to GitLab¶
After committing my changes, I pushed them to the remote repository using:
git add . git commit -m "Initial commit with MkDocs" git push origin main
