[devdocsgjs/main: 631/1867] Fix merge conflicts




commit 16061956ce98c36918ba087192c3c51a3a6042f9
Merge: 3cb97f71 b5bd218e
Author: Jasper van Merle <jaspervmerle gmail com>
Date:   Tue Jun 11 21:59:03 2019 +0200

    Fix merge conflicts

 .editorconfig                                       |  3 +++
 .github/CONTRIBUTING.md                             |  6 +++---
 CODE_OF_CONDUCT.md                                  |  2 ++
 README.md                                           | 12 ++++++------
 docs/adding-docs.md                                 |  9 +++++----
 docs/{Filter-Reference.md => filter-reference.md}   |  0
 docs/maintainers.md                                 |  5 +++--
 docs/{Scraper-Reference.md => scraper-reference.md} |  0
 8 files changed, 22 insertions(+), 15 deletions(-)
---
diff --cc docs/adding-docs.md
index baafc59a,dfc96cb1..a89db7bb
--- a/docs/adding-docs.md
+++ b/docs/adding-docs.md
@@@ -13,10 -13,10 +13,11 @@@ Adding a documentation may look like a 
  6. Generate the full documentation using the `thor docs:generate [my_doc] --force` command. Additionally, 
you can use the `--verbose` option to see which files are being created/updated/deleted (useful to see what 
changed since the last run), and the `--debug` option to see which URLs are being requested and added to the 
queue (useful to pin down which page adds unwanted URLs to the queue).
  7. Start the server, open the app, enable the documentation, and see how everything plays out.
  8. Tweak the scraper/filters and repeat 5) and 6) until the pages and metadata are ok.
- 9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and 
import it in both `application.css.scss` AND `application-dark.css.scss`. Both the file and CSS class should 
be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type 
share the same custom CSS and JS). _(Note: feel free to submit a pull request without custom CSS/JS)_
+ 9. To customize the pages' styling, create an SCSS file in the `assets/stylesheets/pages/` directory and 
import it in both `application.css.scss` AND `application-dark.css.scss`. Both the file and CSS class should 
be named `_[type]` where [type] is equal to the scraper's `type` attribute (documentations with the same type 
share the same custom CSS and JS). Setting the type to `simple` will apply the general styling rules in 
`assets/stylesheets/pages/_simple.scss`, which can be used for documentations where little to no CSS changes 
are needed.
  10. To add syntax highlighting or execute custom JavaScript on the pages, create a file in the 
`assets/javascripts/views/pages/` directory (take a look at the other files to see how it works).
- 11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 
32x32-pixels formats. It'll be added to the icon sprite after your pull request is merged.
- 12. Ensure `thor updates:check [my_doc]` shows the correct latest version.
+ 11. Add the documentation's icon in the `public/icons/docs/[my_doc]/` directory, in both 16x16 and 
32x32-pixels formats. It'll be added to the icon spritesheet after your pull request is merged.
+ 12. Add the documentation's copyright details to the list in 
`assets/javascripts/templates/pages/about_tmpl.coffee`. This is the data shown in the table on the 
[about](https://devdocs.io/about) page, and is ordered alphabetically. Simply copying an existing item, 
placing it in the right slot and updating the values to match the new scraper will do the job.
++13. Ensure `thor updates:check [my_doc]` shows the correct latest version.
  
  If the documentation includes more than a few hundreds pages and is available for download, try to scrape 
it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too 
much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just 
explain how it works in your pull request.)
  


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]