FAQ
What is the purpose of this handbook?
This handbook is designed exclusively for current and future EBRAINS team members. It serves as a comprehensive guide to assist team members in performing their roles effectively.
How do I navigate through the handbook?
The handbook is organized into sections that follow the natural workflow of users—from onboarding to deep technical references. Use the sidebar to quickly jump to different sections, or follow the ‘prev’ and ’next’ links at the end of each page to sequentially browse through related content.
Where can I find specific information on the GitLab at EBRAINS?
GitLab at EBRAINS is the cornerstone for our development processes, encompassing version control, project management, and CI/CD (Continuous Integration/Continuous Deployment).
What should I do if I encounter an issue not covered in this handbook?
For assistance, please contact support
How often is this handbook updated?
The handbook’s content is updated with each new release, typically after every 5-10 commits, or when a critical change needs to be implemented. Check out the release notes
How can I contribute to improving this handbook?
We encourage all EBRAINS members to contribute to this initiative. Simply follow the steps outlined below to get started. How to Contribute Your contributions help improve the handbook and provide valuable insights for all users.
Where exactly do I put my file?
In the root level folder that matches your topic. For example:
- Team process docs →
working-together/ - Technical guides →
technical-deep-dive/ - Tool documentation →
tools-and-resources/
What’s the difference between _index.md and my-page.md?
_index.md creates a section (folder) landing page. my-page.md creates a regular page.
How do I preview my changes?
Working online? You can’t preview easily. Working locally? You need the full handbook app (see technical setup guide). Most authors just commit and trust the review process.
I broke something, help!
Don’t worry! That’s what reviews are for. If you’re really stuck, just share your Markdown file with a project owner and they’ll integrate it for you.