fix: support @example tags#15
Merged
Merged
Conversation
Process example tags, do not convert UDP Yaml to SDP as we still use docfx 2.x.
This reverts commit 9fd4dec.
google-cla
Bot
added
the
cla: yes
bcoe
approved these changes
Oct 25, 2021
bcoe
left a comment
bcoe
left a comment
There was a problem hiding this comment.
I'm excited to see this work in action.
| npx @microsoft/api-extractor run --local | ||
|
|
||
| # install api-documenter deps manually because we're using a forked subdirectory | ||
| cd node_modules/@microsoft/api-documenter/ |
There was a problem hiding this comment.
With OwlBot we've been building docker containers so that it's less likely to have a dependency of a dependency break underneath us.
This might be worth considering if these deps are complex.
| "dependencies": { | ||
| "@microsoft/api-documenter": "7.11.0", | ||
| "@microsoft/api-extractor": "7.8.2-pr1796.0" | ||
| "@microsoft/api-documenter": "https://gitpkg.now.sh/googleapis/rushstack/apps/api-documenter", |
There was a problem hiding this comment.
Interesting I hadn't seen this Vercel service before, had usually just used the Git URL, I'm guessing this is faster and doesn't require git in the tool chain?
Contributor
Author
There was a problem hiding this comment.
It doesn't work for sub directories. This is a workaround.
gcf-merge-on-green Bot
pushed a commit
that referenced
this pull request
Nov 15, 2021
🤖 I have created a release \*beep\* \*boop\* --- ## [0.3.0](https://www.github.com/googleapis/nodejs-cloud-rad/compare/v0.2.8...v0.3.0) (2021-11-15) ### Features * use html instead of markdown for example code snippets ([#18](https://www.github.com/googleapis/nodejs-cloud-rad/issues/18)) ([d606992](https://www.github.com/googleapis/nodejs-cloud-rad/commit/d60699255e99836377b94617dc05bf3f188dc605)) ### Bug Fixes * add overview and fix package link ([#13](https://www.github.com/googleapis/nodejs-cloud-rad/issues/13)) ([933a90f](https://www.github.com/googleapis/nodejs-cloud-rad/commit/933a90f20b1fa8664cee20151032cc9b337320be)) * support [@example](https://www.github.com/example) tags ([#15](https://www.github.com/googleapis/nodejs-cloud-rad/issues/15)) ([98ec467](https://www.github.com/googleapis/nodejs-cloud-rad/commit/98ec467901d55aa767f003b3baad6f996830b5b8)) * use correct branch for documenter ([#16](https://www.github.com/googleapis/nodejs-cloud-rad/issues/16)) ([434fd0f](https://www.github.com/googleapis/nodejs-cloud-rad/commit/434fd0f8eb61b3b993a82ca0ab49d1cd2427e575)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Use our fork of api-documenter. It supports
@exampletags.Use the newest version of api-extractor instead of a fixed pre-release version. This only works with our fork where we do not convert from UDP Yaml to SDP.
Install api-documenter deps manually because we're using a forked subdirectory
Drive-by fix: Supress warnings
Internally: b/174675699 and b/179483748