Skip to content

Commit 0f998f3

Browse files
authored
Moved solid docs to /docs directory (#411)
1 parent 40a5dd3 commit 0f998f3

140 files changed

Lines changed: 9443 additions & 226 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@
55
.sass-cache/
66

77
# ignore generated site
8-
_site/
9-
_deploy/
8+
_docs/.tmp/
109

1110
# ignore node modules
1211
node_modules/

.scss-lint.yml

Lines changed: 0 additions & 180 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Coming soon!
99

1010
## Getting Started
1111

12-
### 1. Set Up
12+
### 1. Set Up
1313

1414
You must have an account with [Github](https://github.com/) and [git](https://help.github.com/articles/set-up-git/) must be installed on your computer.
1515

@@ -20,15 +20,15 @@ Before you can access any BuzzFeed repos, you will need to [generate an SSH key]
2020

2121
### 2. Fork the Repo Locally
2222

23-
Visit <https://github.com/buzzfeed/solid> and click the fork button.
23+
Visit <https://github.com/buzzfeed/solid> and click the fork button.
2424

2525
Next, clone this fork down to your local PC.
2626

27-
### 3. Check Out a New Branch
27+
### 3. Check Out a New Branch
2828

29-
Each time you address a new feature or bug fix, it is best to create a new branch with a descriptive name. That way, it's easy to pause one task and switch to another.
29+
Each time you address a new feature or bug fix, it is best to create a new branch with a descriptive name. That way, it's easy to pause one task and switch to another.
3030

31-
This also simplifies our process of tracking contributions to the master code base.
31+
This also simplifies our process of tracking contributions to the master code base.
3232

3333
```
3434
$ git branch my-feature-or-bug-branch
@@ -64,7 +64,7 @@ The first step is to create a [“remote”](https://help.github.com/articles/ad
6464
$ git remote add origin git://github.com/buzzfeed/solid.git
6565
````
6666

67-
Fetch and merge updates:
67+
Fetch and merge updates:
6868

6969
`IS THIS CORRECT? ⤵`
7070

@@ -83,7 +83,7 @@ $ git push origin my-feature-or-bug-branch
8383

8484
### 8. Submit a Pull Request
8585

86-
Once you're ready to submit your feature or bug, go to your fork on the web (<https://github.com/YOUR_GITHUB_USERNAME/solid>), and click the **Pull Requests** nav item at the top right.
86+
Once you're ready to submit your feature or bug, go to your fork on the web (<https://github.com/YOUR_GITHUB_USERNAME/solid>), and click the **Pull Requests** nav item at the top right.
8787

8888
Next, click the green **New pull request** button and select the following from the dropdowns:
8989

@@ -98,7 +98,7 @@ You should add a concise descriptive comment about what is in this merge, and th
9898

9999
### 9. A Note on Merging
100100

101-
Because of Github permissioning on BuzzFeed repos, it *might* be possible for you to merge your own Pull Request. **Please don't do this!** Always reach out to someone in #solid-prs to merge your PR into develop.
101+
Because of Github permissions on BuzzFeed repos, it *might* be possible for you to merge your own Pull Request. **Please don't do this!** Always reach out to someone in #solid-prs to merge your PR into develop.
102102

103103
# Deprecating Code
104104

@@ -110,4 +110,4 @@ To deprecate SCSS, move the old classes to the very bottom of the SCSS file. Use
110110
.deprecated-class {
111111
color: #000;
112112
}
113-
````
113+
````

DEVELOPING.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,6 @@ Open the site in your web browser:
3535

3636
<http://localhost:9000/>
3737

38-
## Linting
39-
40-
We use scss lint to keep our scss clean and consistent.
41-
42-
To run scss_lint:
43-
44-
`scss-lint scss/`
45-
4638
## Code Snippets
4739

4840
To add code snippets/highlighted syntax to pages in solid, wrap your markup inside <%= ' ' %>

Gruntfile.js

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ module.exports = function(grunt) {
1313
sass: {
1414
lib: {
1515
options: {
16-
sourceMap: false
16+
sourceMap: false,
17+
includePaths: ['_lib']
1718
},
1819
files: [
1920
{
@@ -47,6 +48,17 @@ module.exports = function(grunt) {
4748
cwd: '_lib/',
4849
expand: true
4950
}]
51+
},
52+
build: {
53+
options: {
54+
archive: 'docs/_dist/solid-docs.zip',
55+
mode: 'zip'
56+
},
57+
files: [{
58+
src: ['**/*'],
59+
cwd: 'docs/.tmp/_site/',
60+
expand: true
61+
}]
5062
}
5163
},
5264
copy: {
@@ -73,6 +85,7 @@ grunt.loadNpmTasks('grunt-contrib-copy');
7385
grunt.registerTask('compile_lib', ['sass:lib']);
7486
grunt.registerTask('minify_lib', ['cssnano:lib']);
7587
grunt.registerTask('latest_solid', ['copy:latest']);
88+
grunt.registerTask('zip_build', ['compress:build']);
7689
grunt.registerTask('zip_lib', ['compress:lib']);
7790

7891
}

Makefile

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,15 @@ modules: ruby_gems node_modules
1919
ruby_gems:
2020
bundle install --path=$(BUNDLE_PATH) --clean $(BUNDLE_ARGS)
2121

22-
# deploy site to s3 bucket
23-
deploy: build_deploy s3
22+
# compile binaries for download
23+
# * executed on build
24+
# * not re-run by jekyll serve
25+
dist: build
26+
grunt zip_build
27+
grunt compile_lib
28+
grunt minify_lib
29+
grunt latest_solid
30+
grunt zip_lib
2431

2532
# clean out generated files
2633
clean:
@@ -29,28 +36,15 @@ clean:
2936

3037
# run the jekyll server
3138
run:
32-
bundle exec jekyll serve
39+
(cd docs/ && bundle exec jekyll serve)
3340

3441
# build static site into _site
3542
build:
36-
bundle exec jekyll build
43+
(cd docs/ && bundle exec jekyll build)
3744

3845
# build static site into _deploy
3946
build_deploy:
40-
bundle exec jekyll build --destination _deploy
41-
42-
# compile binaries for download
43-
# * executed on build
44-
# * not re-run by jekyll serve
45-
dist:
46-
grunt compile_lib
47-
grunt minify_lib
48-
grunt latest_solid
49-
grunt zip_lib
50-
51-
# deploy to s3 bucket
52-
s3:
53-
rsync -crvze ssh --delete _deploy/ solid.buzzfeed.com:/var/www/solid.buzzfeed.com/
47+
(cd docs/ && bundle exec jekyll build --destination .tmp/_deploy)
5448

5549
# install node modules from npm-shrinkwrap.json
5650
node_modules:

0 commit comments

Comments
 (0)