Ask a question Share knowledge Edit the page

Participation in the creation of the guide

We're working on a GitLab guide, in AsciiDoc, and we've prepared a guide for you to participate in creating and filling the guide, even if you don't know the technology you need.

A couple of times a month, the editorial boards have different formats of working meetings, and we share knowledge and capture ideas in this guide.
Some meetings are open and you can join us. The best way to learn about such meetings is to sign up for a meeting. Telegram channel @pragmatic_km and follow the announcements.
You can also ask questions to the knowledge management community. I'm snooping..

The easiest way to contribute your material is to submit it to the editorial team as an issue. The team will contact you, clarify the details, and help prepare and publish the material in the appropriate format.

In order to go this way, it is necessary:

Register on the Gitlab platform (If you haven't already)
Confirm your account in a letter from Gitlab
Open the Issues section in the guide repository and share your idea in any form by filling in the Title and Description fields and clicking “Submit issue”.
Follow your emails: when the editorial office will comment on something in GitLab on your application, you will receive letters.

A more difficult way (for those who know how to work with Git and Gitlab) is to make changes to the repository articles themselves and issue Merge Request. At this stage of the development of the guide, we do not have special rules for naming branches or designing articles, the main thing is quality content.

The easiest way to fix typos is to edit the page directly through the GitLab platform, which requires you to have basic skills with GitLab and an account on the platform.

Each page has an “Edit Page” button that leads to the appropriate edit form on the GitLab platform.

If you understand that an article on a topic does not cover important aspects, Press the "Ask a Question" button.We'll send your question to the community of experts where we can work together to find the answer for you.

Another way (for those who know how to work with Git and Gitlab) is to write their questions into the repository articles themselves and make a Merge Request. We believe that an article with the right, deep questions on the topic is a checklist for the diving person, and this is of high value.

Each page has an “Edit Page” button that leads to the appropriate edit form on the GitLab platform.

If you edit articles on your computer, it's convenient to see the result immediately - you can assemble and open the site locally. This is not necessary: edits through the GitLab web interface also work, and the assembled version of the branch will show CI after you make Merge Request.

From the root of the repository, follow:

./bin/serve

The script itself will put dependencies at the first launch and open the site on the Internet. http://localhost:4000Stop it. Ctrl+C.

While the script is working, edits in .html, .md and _data/*.yml They pick up automatically, and the page in the browser reloads itself. _config.yml: After editing the script, you need to restart.

What's useful to know:

Needed. Ruby version 3 or newerSystem Ruby in macOS (2.6) is not suitable - it does not set dependencies. ~/.rubiesIf it's not, it'll tell you the installation command. In CI, the site is going to Ruby 3.1.
If port 4000 is already occupied, run on another port. PORT=4002 ./bin/serveThe script checks the ports in advance and writes down what process holds them.
Addictions are put in the folder .vendor It's inside the project, not inside the system. _siteIt is already excluded from the repository - you do not need to commit them.