GitSwarm 2016.3-2 Documentation


UI Guide for building GitSwarm

GitSwarm UI development kit

We created a page inside GitSwarm where you can check commonly used html and css elements.

When you run GitSwarm instance locally - just visit http://localhost:3000/help/ui page to see UI examples you can use during GitSwarm development.

Design repository

All design files are stored in the gitlab-design repository and maintained by GitSwarm UX designers.

GitSwarm's layout contains 2 sections: the left sidebar and the content. The left sidebar contains a static navigation menu. This menu will be visible regardless of what page you visit. The left sidebar also contains the GitSwarm logo and the current user's profile picture. The content section contains a header and the content itself. The header describes the current GitSwarm page and what navigation is available to user in this area. Depending on the area (project, group, profile setting) the header name and navigation may change. For example when user visits one of the project pages the header will contain a project name and navigation for that project. When the user visits a group page it will contain a group name and navigation related to this group.

Adding new tab to header navigation

We try to keep the amount of tabs in the header navigation between 5 and 10 so that it fits on a typical laptop screen. We also try not to confuse the user with too many options. Ideally each tab should represent separate functionality. Everything related to the issue tracker should be under the 'Issues' tab while everything related to the wiki should be under 'Wiki' tab and so on and so forth. When adding a new tab to the header don't use more than 2 words for text in the link. We want to keep links short and easy to remember and fit all of them in the small screen.

Mobile screen size

We want GitSwarm to work well on small mobile screens as well. Size limitations make it is impossible to fit everything on a mobile screen. In this case it is OK to hide part of the UI for smaller resolutions in favor of a better user experience. However core functionality like browsing files, creating issues, writing comments, should be available on all resolutions.

Icons

Buttons

Counts