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
  • !26732

Reorganize docs for easier deploys

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Mark Otto requested to merge mv-docs into v4-dev Jun 21, 2018
  • Overview 0
  • Commits 13
  • Pipelines 0
  • Changes 244

With the current docs directory setup, I'm making too many mistakes and have to manually address path changes and directory moves on deploy. This makes for a frustrating experience developing locally and shipping releases. With this PR, we're basically back to the same setup from v3—duplicating the dist/ directory into our site/docs/ directory. Not the most ideal, but very straightforward for me as the release manager.

I still need to double check the service worker stuff, asset paths, and confirm the watch tasks pickup the copy-pasta.

/cc @twbs/team


  • mkdir site
  • git mv docs/ site/docs/
  • git mv _layouts/ site/_layouts/
  • git mv _data/ site/_data/
  • git mv _includes site/_includes/
  • git mv assets site/docs/4.1/assets/
  • Update _config.yml's source to "site"
  • git mv favicon.ico site/favicon.ico
  • git mv index.html site/index.html
  • git mv sw.js site/sw.js
  • git mv robots.txt site/robots.txt
  • Update sw.js path
  • Update CSS/JS paths
  • Update social image paths
  • Modify package.json scripts do duplicate dist into site directory
    • css-main needs && cp -r dist/css/ site/docs/4.1/dist/css/ added
    • js-main needs && cp -r dist/js/ site/docs/4.1/dist/js/ added
  • Test, test, test!

Fixes #26637 (closed) and fixes #26267 (closed) along the way.

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