📐
DataSF | Data Standards Handbook
  • Introduction
  • Data Structure and Formats
    • Data Structure and Formats
      • Column Headers & Order
      • Date and Time
      • Text
      • Numeric
      • Location (coordinates)
      • Location (addresses)
  • Standard Reference Data
    • Reference Data Overview
    • Reference: General Admin
      • Department Names and Codes
    • Reference: Demographics
      • Sexual Orientation & Gender Identity
      • Race and Ethnicity
        • City and County of San Francisco
          • San Francisco Recommended Standard
            • Appendices
          • Department of Public Health’s Ethnicity Guidelines
        • State of California
        • Federal Government
    • Reference: Basemap
      • Overview
      • Parcels
      • Building Footprints
      • Address Numbers
      • Street Names
      • Street Suffix Abbreviations
      • Street Centerlines and Nodes
    • Reference: Boundaries
      • Census
      • Neighborhoods
      • Supervisor Districts
      • Zoning Use Districts
  • Appendix
    • Reserved Column Names
    • Reference Data Index
    • Contributing
    • Acknowledgements
    • License
    • See our other explainers
Powered by GitBook
On this page
  • Organizing Files
  • Table of Contents
  • Introduction Page
  • Send a Pull Request
  • Enjoy the Offline Docs

Was this helpful?

  1. Appendix

Contributing

PreviousReference Data IndexNextAcknowledgements

Last updated 5 years ago

Was this helpful?

All of this documentation is open source and . If you see something that you can contribute, submit a pull request with your edits! To make this easy you can click the "Edit this page" link at the top of the web docs.

The docs are all written in . If you've used GitHub, it's pretty likely you've encountered it before. You can become a pro in a few minutes by reading their .

Organizing Files

You'll notice that the is in a logical structure. Each of the major sections is a folder. For example the 'Reference: Basemap' pages are in the folder basemap in the top level of the repository.

Some of the chapters are split into multiple sections to help break up the content and make it easier to digest. You can easily see how chapters are laid out by looking at the SUMMARY.md file. This convention helps keep chapters together in the file system and easy to view either directly on github or gitbook.

Table of Contents

You'll find the table of contents in the file. It's a nested list of markdown links. You can link to a file simply by putting the filename (including the extension) inside the link target.

Introduction Page

This is the root file. It's intent is to give the reader an elevator pitch of what this document is about is and why we think it is useful.

Send a Pull Request

So that's it. You make your edits, keep your files and the Table of Contents organized, and .

Enjoy the Offline Docs

Moments after your edits are merged, they will be automatically published to the web, as a downloadable PDF, .mobi file (Kindle compatible), and ePub file (iBooks compatible).

available to edit on GitHub
GitHub Flavored Markdown
GFM Documentation page
GitHub Repo
SUMMARY.md
README.md
send us a pull request