be-navigation

Buyer Experience Navigation

Buyer Experience Navigation (be-navigation) contains a modular navigation for about.gitlab.com.

• be-navigation is a Vue 2 CLI app that features our implementation of GitLab's marketing website's navigation.

• be-navigation is a collection of navigation components. Currently housing the main navigation and the footer.

• be-navigation uses GitLab's Slippers UI design system.

Getting Started

Dependencies

• Node - Check .nvmrc for the current node version.

Local development

Start app: npm run serve

Auto-lint: npm run lint

Updating NPM package and releasing a new version

1. Create a new issue titled Navigation release: Version x.x.xx and include links to the MRs and Issues included in this release
2. Create a new branch from main, with all changes
3. Increment the version number in package.json
4. Build /dist folder - npm run build-library
5. Publish to npm - npm publish (Note: You may need to login with your npm credentials using npm login)
6. Merge changes to origin/main
7. Once the package has been published it's now ready to be updated in the consuming repositories (Example: www, Buyer Experience). Include links to those MRs in your Navigation Release Issue
8. Close the Navigation Release Issue

Installation

be-navigation is available as an npm package.

// with npm
npm install be-navigation

// with yarn
yarn add be-navigation