Bring back the /docs directory
#12037
Conversation
|
Unrelated, but why are all our builds failing? @fat, Travis says the qunit tests are fubared—perhaps something you did in the last week? |
|
@mdo There's some recent mild wonkiness in the Sauce service or toolchain with a couple of the browser/OS combos; don't think it's an actual problem in our JS. (Might be a bad version update on their end or something.) |
|
@cvrebert Gah, okay. Anything we can do? Even if it's just to connect with them? And let me know your thoughts on this PR, too, please :). |
|
(Although the fact that our QUnit version is so outdated can't be helping things; see #11240). |
|
@mdo @fat: I stand corrected. We are getting some real JS errors; the grunt plugin is just not reporting this fact very well (again, possibly due to old QUnit).
(And for that matter, OS X Firefox has been failing 1 tooltip test for a while, which is why it's been disabled in our Sauce config, along with all IE versions... 😞 Would be nice if we could get all the platforms enabled+passing again.) |
| @@ -196,6 +196,23 @@ module.exports = function (grunt) { | |||
| expand: true, | |||
| src: ['fonts/*'], | |||
| dest: 'dist/' | |||
| }, | |||
| dist_css: { | |||
There was a problem hiding this comment.
Should be in mixedCase per JS convention? Or is there a Grunt convention for task naming?
There was a problem hiding this comment.
Also, perhaps include "doc" or "docs" in the names of these new tasks?
|
I think it's definitely a net win to do this move. |
@cvrebert Let's open a new issue and ping @fat about that stuff. In the mean time, perhaps we comment those out again to get some green back in our lives? |
| @@ -199,6 +199,23 @@ module.exports = function (grunt) { | |||
| expand: true, | |||
| src: ['fonts/*'], | |||
| dest: 'dist/' | |||
| }, | |||
| docsDistCss: { | |||
There was a problem hiding this comment.
This can replace all three targets
docs: {
expand: true,
cwd: './dist',
src: [
'{css,js}/*.min.*',
'{css,js}/*.map',
'fonts/*'
],
dest: 'docs/dist'
}
| cwd: './dist', | ||
| src: [ | ||
| '{css,js}/*.min.*', | ||
| '{css}*.map', |
There was a problem hiding this comment.
Sorry, this is my bad from the original snippet. There should be a / after {css}
There was a problem hiding this comment.
Nah, it was my fault I think—I changed the line to not include ,js within the braces (unless you edited the comment). Either way, all set :).
There was a problem hiding this comment.
😉 I did edit it a second or two after I posted
This moves all documentation files to a
/docssubdirectory to help clean up the file tree. Here are some thoughts on what's changed and why it matters..htmlfiles,/examples, and Jekyll directories have been moved to a subfolder,/docs._config.ymlfile has been cleaned up. Nested configs look way better. I was also able to remove all theexcludelists since the stuff we really need to compile the docs is now all in one spot, free of extra noise.{{ page.base_url }}with{{ site.baseurl }}. Better to use an official config setting than a custom one on each page. This does, however, mean that folks who fork Bootstrap need to change thebaseurloption in Jekyll if they wish to host our docs themselves. I'm not worried in the slightest about this.By moving the Jekyll folders, our examples, docs assets, HTML files, and docs license to the subdirectory, we effectively lose 13 items from the root directory. The root file tree looks like this now:
It's a bit better, but could still use some cleanup. I'm curious if we could punt any of those other files somewhere else. It'd be great if a repo could just have a
.files/directory for this stuff./cc @fat, because <3.