Closed Bug 1247071 Opened 8 years ago Closed 8 years ago

Update "Load Data" docs

Categories

(developer.mozilla.org Graveyard :: BrowserCompat, defect)

All
Other
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: jwhitlock, Assigned: jwhitlock, Mentored)

References

Details

(Whiteboard: [bc:infra][bc:milestone=bicycle])

What did you do?
================
1. Go to http://browsercompat.readthedocs.org/en/latest/installation.html#load-data

What happened?
==============
It mentions three methods:

1. Load from GitHub
2. Load from another server
3. Load from web platform project

What should have happened?
==========================
Methods 1 and 2 are probably broken by bug 1195518, which should be noted until it is fixed.

Method 3 was good for initial development, but should be removed now that the importer is more mature, along with tools/load_webcompat_data.py

Finally, the fastest way is not documented, to use the documentation test cases, such as:

tools/upload_data.py --data docs/v1/resources

Is there anything else we should know?
======================================
Blocks: 996570
Mentor: jwhitlock
Whiteboard: [specification][type:bug] → [bc:infra][bc:milestone=bicycle]
Depends on: 1195518
Assignee: nobody → jwhitlock
Status: NEW → ASSIGNED
Commits pushed to master at https://github.com/mdn/browsercompat

https://github.com/mdn/browsercompat/commit/83282af40c0024ee6d76b24337380371faedda93
bug 1247071 - Remove load_webcompat_data.py

Now that we are scraping data directly from MDN, remove
tools/load_webcompat_data.py and related documentation.

https://github.com/mdn/browsercompat/commit/3e9aa56a92a11877959fd0cddb3ea53a1139cbe4
bug 1247071 - Remove tools/sample_mdn.py

This tool was used for project requirement gathering, and is no longer
needed.

https://github.com/mdn/browsercompat/commit/330297d86ae104b1394ebfc7bc7b86416b31a576
fix bug 1247071 - Loading documentation fixtures

Document how to load documentation fixtures, which should be the
prefered solution for code reviewers who need to do live testing.

https://github.com/mdn/browsercompat/commit/005171cfe9e53991d4c2a2f4cdef3471684bce7d
Merge pull request #108 from mdn/load_data_docs_1247071

bug 1247071 - Update install docs for loading data, delete obsolete tools
Status: ASSIGNED → RESOLVED
Closed: 8 years ago
Resolution: --- → FIXED
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.