Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Add Atom's API docs to the Flight Manual #541

Merged
merged 69 commits into from
Jul 26, 2019
Merged

Add Atom's API docs to the Flight Manual #541

merged 69 commits into from
Jul 26, 2019

Commits on Apr 30, 2019

  1. Configuration menu
    Copy the full SHA
    786dd03 View commit details
    Browse the repository at this point in the history
  2. Replicate class page title

    lee-dohm committed Apr 30, 2019
    Configuration menu
    Copy the full SHA
    8c9fe2d View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    3ec7b61 View commit details
    Browse the repository at this point in the history

Commits on May 13, 2019

  1. Configuration menu
    Copy the full SHA
    ca5643e View commit details
    Browse the repository at this point in the history

Commits on May 22, 2019

  1. Configuration menu
    Copy the full SHA
    e2ad79e View commit details
    Browse the repository at this point in the history

Commits on May 24, 2019

  1. Configuration menu
    Copy the full SHA
    c2d23c5 View commit details
    Browse the repository at this point in the history

Commits on Jun 10, 2019

  1. Configuration menu
    Copy the full SHA
    4b98ceb View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    1c85628 View commit details
    Browse the repository at this point in the history

Commits on Jun 25, 2019

  1. Configuration menu
    Copy the full SHA
    6ccef21 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    069d94d View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    0984b6f View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    8bc9122 View commit details
    Browse the repository at this point in the history

Commits on Jun 26, 2019

  1. Move JSON splitting from Rake to Gulp

    Replace the `split_api_json` Rake task with equivalent logic in 
    `gulpfile.js`, so that `npm run gulp` continues to provide the 
    end-to-end build process.
    jasonrudolph committed Jun 26, 2019
    Configuration menu
    Copy the full SHA
    42c10c6 View commit details
    Browse the repository at this point in the history
  2. 🔥 Remove unused arg

    jasonrudolph committed Jun 26, 2019
    Configuration menu
    Copy the full SHA
    8595b00 View commit details
    Browse the repository at this point in the history
  3. Fix "stdout maxBuffer exceeded" error when building site

    Prior to this change, the the 'nanoc:compile' gulp task attempted to 
    store the complete output of `nanoc:compile` in a string, which resulted 
    in a "stdout maxBuffer exceeded" error. By using `spawn` instead of 
    `exec`, we can pipe the output of `bundle exec nanoc compile` to STDIO 
    and thus avoid trying to fit it all in a string.
    
    Example build failure: 
    https://travis-ci.org/atom/flight-manual.atom.io/builds/550937870#L3656
    jasonrudolph committed Jun 26, 2019
    Configuration menu
    Copy the full SHA
    98f177e View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    3d25e59 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    76a088c View commit details
    Browse the repository at this point in the history

Commits on Jun 27, 2019

  1. Avoid long periods of no output from run_proofer task

    Prior to this change, we were getting the following failure on CI:
    
    > No output has been received in the last 10m0s, this potentially
    > indicates a stalled build or something wrong with the build itself.
    > ...
    > The build has been terminated
    
    This was due to the `run_proofer` task running for more than 10 minutes
    with no output. To prevent that situation, this commit introduces two
    changes:
    
    1. Split up the proofer work. Invoke HTMLProofer on each directory
    separately, so that the `run_proofer` task reports intermediate
    progress. Instead of waiting until _all_ directories have been proofed
    before outputting any results, it will now output results for each
    directory immediately after proofing that directory.
    
    2. Don't run HTMLProofer on the API docs. Checking all external links
    for all versions of the API docs would likely take a l-o-n-g time. I
    don't think we want our builds taking that long. If we _do_ want to run
    the proofer on all versions of the API docs, perhaps it could happen as
    part of a nightly build, as opposed to happening on every push.
    
    Example build failure: https://travis-ci.org/atom/flight-manual.atom.io/builds/550971951#L7122
    jasonrudolph committed Jun 27, 2019
    Configuration menu
    Copy the full SHA
    22558dd View commit details
    Browse the repository at this point in the history
  2. Merge pull request #537 from atom/jr/api-docs

    Enhance build to process API JSON files for Atom 1.0.0 and newer
    jasonrudolph authored Jun 27, 2019
    Configuration menu
    Copy the full SHA
    2c08ae9 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    399c712 View commit details
    Browse the repository at this point in the history
  4. Linkify instance property names

    Co-authored-by: Antonio Scandurra <[email protected]>
    jasonrudolph and Antonio Scandurra committed Jun 27, 2019
    Configuration menu
    Copy the full SHA
    189c8bd View commit details
    Browse the repository at this point in the history
  5. Toggle display of instance property description onclick

    Co-Authored-By: Antonio Scandurra <[email protected]>
    jasonrudolph and Antonio Scandurra committed Jun 27, 2019
    Configuration menu
    Copy the full SHA
    a9df28e View commit details
    Browse the repository at this point in the history
  6. Honor URL hash to display instance property description

    Co-Authored-By: Antonio Scandurra <[email protected]>
    jasonrudolph and Antonio Scandurra committed Jun 27, 2019
    Configuration menu
    Copy the full SHA
    8e119a3 View commit details
    Browse the repository at this point in the history
  7. Linkify method names and toggle details onclick

    Co-Authored-By: Antonio Scandurra <[email protected]>
    jasonrudolph and Antonio Scandurra committed Jun 27, 2019
    Configuration menu
    Copy the full SHA
    6cdbad6 View commit details
    Browse the repository at this point in the history
  8. Render class-level examples

    Note: The code samples emitted by this change are not yet rendered with 
    syntax highlighted.
    jasonrudolph committed Jun 27, 2019
    Configuration menu
    Copy the full SHA
    4649175 View commit details
    Browse the repository at this point in the history
  9. Fix the HTMLProofer build failures

    This reverts commit 22558dd and adopts an alternative approach to the
    problem. We continue to *NOT* run the link checker on the API docs (for
    the reasons described in the commit messages for 22558dd), but we run
    the HTMLProofer on the root of the output directory, so that internal
    links can be properly resolved.
    jasonrudolph committed Jun 27, 2019
    Configuration menu
    Copy the full SHA
    5dfe19b View commit details
    Browse the repository at this point in the history

Commits on Jul 1, 2019

  1. Begin populating search index with API docs

    With these changes, we populate the search index with all instance
    methods present in the latest version of Atom. Next up, we'll need to
    add classes, class methods, and instance properties to the search index.
    
    Co-Authored-By: Antonio Scandurra <[email protected]>
    jasonrudolph and Antonio Scandurra committed Jul 1, 2019
    Configuration menu
    Copy the full SHA
    aeee307 View commit details
    Browse the repository at this point in the history
  2. Fix URL to API docs in search index

    Co-Authored-By: Antonio Scandurra <[email protected]>
    jasonrudolph and Antonio Scandurra committed Jul 1, 2019
    Configuration menu
    Copy the full SHA
    74475a7 View commit details
    Browse the repository at this point in the history
  3. Fix ellipsis

    jasonrudolph committed Jul 1, 2019
    Configuration menu
    Copy the full SHA
    b0526cd View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    fb77ad9 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    4599da9 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    0a417a8 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    f3cc52e View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    4685379 View commit details
    Browse the repository at this point in the history

Commits on Jul 2, 2019

  1. Configuration menu
    Copy the full SHA
    4a78c06 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    8416455 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    387eeee View commit details
    Browse the repository at this point in the history
  4. Add helpful redirects for API-related paths

    - Redirect `/api` to `/api/latest`
    - Redirect `/api/latest` to the latest version of the API docs
    - Redirect `/api/<some-version>` to `/api/<some-version>/AtomEnvironment`
    
    This is fully functional, but there are a handful of TODO items that I
    want to address in some follow-up commits to tidy things up. 😇
    jasonrudolph committed Jul 2, 2019
    Configuration menu
    Copy the full SHA
    b8b8986 View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    7ece9a2 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    3451c8d View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    de1e02a View commit details
    Browse the repository at this point in the history
  8. Configuration menu
    Copy the full SHA
    2bcdb3c View commit details
    Browse the repository at this point in the history

Commits on Jul 3, 2019

  1. Configuration menu
    Copy the full SHA
    355e99c View commit details
    Browse the repository at this point in the history
  2. 1 Configuration menu
    Copy the full SHA
    566ae12 View commit details
    Browse the repository at this point in the history
  3. 1 Configuration menu
    Copy the full SHA
    c6f7905 View commit details
    Browse the repository at this point in the history
  4. 1 Configuration menu
    Copy the full SHA
    b521ac6 View commit details
    Browse the repository at this point in the history

Commits on Jul 4, 2019

  1. Fix compilation of non-API pages

    Co-Authored-By: Jason Rudolph <[email protected]>
    Antonio Scandurra and jasonrudolph committed Jul 4, 2019
    Configuration menu
    Copy the full SHA
    ba691d3 View commit details
    Browse the repository at this point in the history

Commits on Jul 5, 2019

  1. Honor selected version during search

    Antonio Scandurra committed Jul 5, 2019
    Configuration menu
    Copy the full SHA
    d8470a0 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    b14caf0 View commit details
    Browse the repository at this point in the history
  3. Fix warnings in search.js

    Antonio Scandurra committed Jul 5, 2019
    Configuration menu
    Copy the full SHA
    373fa93 View commit details
    Browse the repository at this point in the history
  4. Redirect to the versioned API page when selecting a new version

    Antonio Scandurra committed Jul 5, 2019
    Configuration menu
    Copy the full SHA
    9c457cd View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    ccef5c1 View commit details
    Browse the repository at this point in the history

Commits on Jul 15, 2019

  1. Move API docs functionality from search.js to api-docs.js

    Antonio Scandurra committed Jul 15, 2019
    1 Configuration menu
    Copy the full SHA
    b3e6add View commit details
    Browse the repository at this point in the history
  2. Label "Public" classes as "Essential"

    Prior to this change, "Public" classes were labeled as "Public", which
    differs from the behavior on atom.io. See screenshot:
    
    https://user-images.githubusercontent.com/2988/60625837-f0bc6d00-9db6-11e9-83f4-0e78c12d96cb.png
    
    This commit resolves that discrepancy. "Public" classes will now be
    labeled as "Essential".
    jasonrudolph committed Jul 15, 2019
    Configuration menu
    Copy the full SHA
    60234aa View commit details
    Browse the repository at this point in the history
  3. Add label to denote optional arguments

    Prior to this change, the rendered docs didn't indicate which arguments
    were optional. This differed from the behavior on atom.io. See
    
    https://user-images.githubusercontent.com/2988/60625840-f1550380-9db6-11e9-821c-d75d31511e15.png
    
    This commit resolves that discrepancy. Optional arguments will now have
    an "optional" badge.
    jasonrudolph committed Jul 15, 2019
    Configuration menu
    Copy the full SHA
    5a0f390 View commit details
    Browse the repository at this point in the history

Commits on Jul 16, 2019

  1. Add syntax highlighting for code examples in API docs

    Co-Authored-By: Jason Rudolph <[email protected]>
    Antonio Scandurra and jasonrudolph committed Jul 16, 2019
    Configuration menu
    Copy the full SHA
    73b0e94 View commit details
    Browse the repository at this point in the history
  2. Start on grouping methods by their visibility

    Co-Authored-By: Jason Rudolph <[email protected]>
    Antonio Scandurra and jasonrudolph committed Jul 16, 2019
    Configuration menu
    Copy the full SHA
    01d81c7 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    128cf11 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    1625298 View commit details
    Browse the repository at this point in the history
  5. 🎨 Move method

    jasonrudolph committed Jul 16, 2019
    Configuration menu
    Copy the full SHA
    f568383 View commit details
    Browse the repository at this point in the history
  6. Configuration menu
    Copy the full SHA
    0b7fde1 View commit details
    Browse the repository at this point in the history
  7. Configuration menu
    Copy the full SHA
    f6c1ff9 View commit details
    Browse the repository at this point in the history

Commits on Jul 17, 2019

  1. Don't hard-wrap when encountering newlines

    With the introduction of kramdown in 73b0e94, we started interpreting
    newline characters as hard wraps, which was causing paragraphs to not
    take advantage of all the available screen real estate. Documentation is
    usually hard-wrapped for readability purposes when navigating source
    code, but those concerns don't apply when viewing the same documentation
    in a web browser.
    
    This commit fixes the visual glitch illustrated above by supplying
    `hard_wrap: false` to  kramdown-gfm. I verified that this doesn't affect
    the rendering of other markdown constructs such as code block syntax
    highlighting.
    Antonio Scandurra committed Jul 17, 2019
    Configuration menu
    Copy the full SHA
    b4c3dc0 View commit details
    Browse the repository at this point in the history
  2. Replace input type from "search" to "text"

    This ensures that Safari doesn't apply a custom style that prevents the 
    text box from being displayed correctly.
    Antonio Scandurra committed Jul 17, 2019
    Configuration menu
    Copy the full SHA
    9f85a96 View commit details
    Browse the repository at this point in the history
  3. Remove commented-out code

    lee-dohm committed Jul 17, 2019
    Configuration menu
    Copy the full SHA
    1ec6b44 View commit details
    Browse the repository at this point in the history
  4. 4 Configuration menu
    Copy the full SHA
    47cbabf View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    92981c2 View commit details
    Browse the repository at this point in the history

Commits on Jul 25, 2019

  1. Configuration menu
    Copy the full SHA
    9ee89a4 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    7b48541 View commit details
    Browse the repository at this point in the history