Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • B bootstrap
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 263
    • Issues 263
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 114
    • Merge requests 114
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Bootstrap
  • bootstrap
  • Merge requests
  • !22717

Rearrange all the docs to allow for a docs/major.minor/ setup

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Mark Otto requested to merge docs-rearrange into v4-docs-streamlined May 29, 2017
  • Overview 0
  • Commits 20
  • Pipelines 0
  • Changes 238

This PR rearranges almost all of the docs/ folder to better allow us to group actual documentation at getbootstrap.com/docs/4.0/. It builds on #22716 and would merge into that branch if accepted. The best way to take in the changes is to browse the branch.

Given the size of the diff, here's what's changed.

  • The Jekyll source is no longer docs—it's the entire project.

  • All the existing docs pages, minus the home page and about section are in docs/4.0/.

  • The docs/4.0/ folder will be renamed (via git mv) with each minor/major release. Deploying these changes to our production site is a manual copy-pasta dance, so we'll never lose old versions of the core docs.

  • We no longer have two dist directories. Previously, we had one in the root and one more duplicated via npm script in docs/ because Jekyll couldn't read from outside the source directory. This is the bulk of those 15,000 lines deleted.

  • Moves some root dot files around. The .github is new and contains the contributing guidelines and issue template. The build directory contains the .htmllintrc and .htmlhintrc files.

  • There are a ton more files and folders in our root directory. Not great, but not the end of the world to shave some code from the project.

I have no idea if this is the right approach, but it works for now. If this ends up shipping, we'll need to tackle a few more todos:

  • Update all URLs within docs pages
  • Update links to contributing docs and issue template. This will be done at launch.
  • Look into consolidating more root directory files elsewhere (travis, hound, bable)
  • Verify we need all these package manager files (sache.json, package.js, composer.json, etc)
  • Consider nuking root changelog.md since we don't use it.
  • Figure out if htmllint and htmlhint are both needed (real talk this messed with me a ton)

Gimme your thoughts—is there a better way?

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: docs-rearrange