Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for getting started and writing plugins #417

Open
wants to merge 15 commits into
base: kotlin-experiments
Choose a base branch
from

Conversation

garyttierney
Copy link
Contributor

See https://apollo-rsps.github.io/.

TODO list for documentation to be written. Ideally, we need docs on: building the server, configuring it, extending it, developing plugins for it, and some per-plugin documentation for those with DSLs or public APIs

@Major- Major- added the needs-discussion The project maintainers request input from users label Jul 13, 2019
@garyttierney
Copy link
Contributor Author

TODOs:

  • Documentation to finish writing
    • Listening to server events
    • Exporting code from a plugin
    • Writing plugin tests
  • Branding the AsciiDoc output
  • Better navigation (search?)
  • Generate javadoc and kdoc for the project and plugins

@Major- ?

@garyttierney garyttierney force-pushed the kotlin-experiments-docs branch from e5b9ded to 011eca1 Compare July 16, 2019 19:15
@codecov
Copy link

codecov bot commented Jul 16, 2019

Codecov Report

❗ No coverage uploaded for pull request base (kotlin-experiments@12b4bef). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@                  Coverage Diff                  @@
##             kotlin-experiments     #417   +/-   ##
=====================================================
  Coverage                      ?   23.29%           
  Complexity                    ?      809           
=====================================================
  Files                         ?      655           
  Lines                         ?    11343           
  Branches                      ?     1591           
=====================================================
  Hits                          ?     2642           
  Misses                        ?     8446           
  Partials                      ?      255

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 12b4bef...1c8637c. Read the comment docs.

@garyttierney garyttierney force-pushed the kotlin-experiments-docs branch from b2b07d2 to 14eb63b Compare July 17, 2019 22:17
@garyttierney garyttierney force-pushed the kotlin-experiments-docs branch 2 times, most recently from f3559bb to 6b71da2 Compare August 4, 2019 22:32
@garyttierney garyttierney force-pushed the kotlin-experiments-docs branch from 6b71da2 to 8c12583 Compare August 4, 2019 22:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-discussion The project maintainers request input from users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants