Skip to content

Latest commit

 

History

History
185 lines (111 loc) · 9.69 KB

CONTRIBUTING.md

File metadata and controls

185 lines (111 loc) · 9.69 KB
Raw

Contributions

You may know why we started this project or you might not, but whatever it is, we are very happy you are thinking on contributing.

Table of Contents

How to contribute

Enhance content

Anyone is welcome to contribute to this repository, not only the ArcGIS Experts listed here, so please feel free to do any contribution.

Improve an existing resource page

The awesome list compiles many resource pages but because technology change fast, they could miss many resources and other may be out to date or broken.

You can contribute improving existing resource pages by:

Note: remember you can use ArcGIS Search Engine to help you find great resources and also find inspiration in the template resource pages.

Suggest a new resource page

Use Github issues to suggest a new resource page, but first check the existing issues to verify no one else has already requested it. In case no one else has done it, open up an issue.

Template to request a new resource page

Start a new resource page

You can start a resource page based on your needs or check the existing issues to help someone else.

The first think you will have to do is decide in which folder you would place this resource page, to do that we encourage you to explore the SUMMARY.md file.

Afterwards and depending on the resource page you want you start, you might find these resource templates useful.

In case you don't, start drafting it, think the structure (maybe you can get ideas from the other resource page templates) and start collecting links.

Note: remember you can use ArcGIS Search Engine to help you find great resources and you can try to reach an ArcGIS Experts to help you with it.

And finally, if you think the structure you have built could be share by other resource pages, please create a template or let us know

Check existing links

You can help us checking broken links programmatically running this command:

$ node deploy.js --links

This will display a link of messages but also it will create a bunch of files (called ab-results--[PATH TO FILE]) with a JSON containing detailes information about the state of the links in this repo.

You can place them in the ignored folder awesomebot-results.

$ mkdir awesomebot-results && mv ab-* awesomebot-results

Close existing issues

You can also contribute helping us to close issues find existing issues with content that have been already requested

Become a maintainer

If you are an ArcGIS Experts and are willing to help us curate and maintain a resource page please let us know writing to raul.jimenez@esri.es.

Improve the web application

Suggesting ideas or implementing ideas.

Tutorials

Commenting on Disqus (< 1 min)

If you are in the build version made with Gitbook and you can report a broken link or suggest a new resource using Disqus. You can do it like so:

Animation adding a comment on Disqus

Opening an issue (< 1 min)

Note: This option requires you to have a Github account

How to open a Github issue:

Animation opening an issue

We have built several templates with some guidelines to help anyone to contribute:

Using: Github Online Editor (< 2 min)

Note: This option requires you to have a Github account

Edit a resource page from your browser: learn how.

Or you can also watch this video to learn how to create a new page using the Github Online Editor:

Animation showing how to use the Github Online Editor

Using: Your favourite IDE

Note: This option requires you to have a Github account

If you are a developer you can fork this repo, make your contributions and do a pull request

Optionally you can also create a new build.

Install and build

First you need to have npm installed in your computer. Afterwards, from the root folder run:

$ npm install
$ npm run install

To start the development environment run:

$ npm run serve

Be patient, it will take some time but whenever it is ready you will see a message saying Serving book on http://localhost:4000

And whenever you are ready to create the new deployment run:

$ npm run build

Be patient, this process can take a few minutes

Configurations

  • Ignore files and folders on build: You can extract folders and files from the book adding them to the ignores property at book.json

  • Exclude from awesomebot: if we want the deploy.js script to avoid checking links on any folder or file we can add it to the excludeFromLinkChecker array at deploy.js

  • Exclude from doctoc: every table of contents (TOC) is generated automatically. If you don't want them to have a TOC edit the deploy.js script and add any file or folder to excludeFromDocToc array.

  • Fixing summary/"book index": by default the index is generated automatically using gitbook-summary which can provoke unexpected behaviors:

    • Capitalization: , and it provides the folder name capitalized to each chapter. You can overwrite this capitalization adding a new value to summary_titles array.
    • Splitted names: names containing numbers or capitals can be splitted. You can add a array to the replace_titlesto define a new value for those indexes.

Project misuse

Do not use this issues to request help to solve specific problems or doubt with a product/API/SDK.

If you need help to solve specific problems about any technology follow these steps:

  1. Search the resource page for this topic inside the awesome list of resources
  2. Check resources and if you don't find anything helpful go to the community section
  3. Search a solution in theses communities
  4. If you do not find the solution, request help in the community and mention any ArcGIS expert you might have found.