Planning
Mike Moore edited this page Apr 2, 2018
·
4 revisions
This page is the home for improvements to this project that do not belong in the Feature backlog.
There is a strong consensus to move the gh-pages documentation to a community-standard format with a GCP theme. The most likely format is the default output of YARD. See google-cloud-ruby on rubydoc.info for a non-customized, default example. This format can be customized with GCP branding, and we have branding assets (CSS, etc) that we used for the documentation prior to the Angular site app.
The new format needs to resolve the following cleanup issues, which were closed on 2018-3-6 (but not fixed) due to delays in moving to a new format:
- Links to source code of methods on protobuf types are broken
- Full YARD parameter type is not displayed in documentation
- Links to library methods not resolved in guides
- gh-pages "umbrella" package nav not active when Protobuf type is viewed
- 'Data Types' nav item not active when GAPIC type is viewed
- Positional vs. named arguments
- Yield param types do not link
- Add Search
- Add API Reference
- Add inheritance to Code Constucts JSON
- Add namespace navigation to Code Constucts JSON
- Add type to Code Constructs JSON
- Add Method Groups
- Add line numbers to longer code examples