remote-apis icon indicating copy to clipboard operation
remote-apis copied to clipboard

Design doc link

Open alercah opened this issue 6 years ago • 2 comments

Is the main google doc design doc still maintained to match the API? If so, should it be linked here? I am pointing some people at the API and was surprised that it isn't linked. Alternatively, perhaps it should be moved into the repository in Markdown so that it can be updated alongside the proto?

alercah avatar Jan 19 '19 05:01 alercah

The doc is no longer maintained. We're in the process of moving it to Markdown, although not alongside the proto. Internally, cl/228569321.

On Sat, Jan 19, 2019 at 12:00 AM Alexis Hunt [email protected] wrote:

Is the main google doc design doc still maintained to match the API? If so, should it be linked here? I am pointing some people at the API and was surprised that it isn't linked. Alternatively, perhaps it should be moved into the repository in Markdown so that it can be updated alongside the proto?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/bazelbuild/remote-apis/issues/49, or mute the thread https://github.com/notifications/unsubscribe-auth/AYoKuOtipmwH84x3xkSKD1CaKgd4Mmooks5vEqZggaJpZM4aI9yS .

ola-rozenfeld avatar Feb 05 '19 16:02 ola-rozenfeld

I think Alexis is actually referring to the historical design docs, so we have a record of decisions that we've made in the past. I think those docs should be linked from this repo. I don't think it's worth converting them to markdown.

I'll track down the relevant docs and add a link.

bergsieker avatar Mar 12 '19 02:03 bergsieker