Is there a public git repo for the CBL and/or Sync Gateway documentation?

[Paul Capestany]

I personally really liked when all the documentation lived in the Github wikis, it was pretty easy to keep track of changes to the documentation that way. I looked around and saw that there's https://github.com/couchbaselabs/docs-ng and https://github.com/couchbase/docs-cb4 ...but neither of those seem to contain CBL or Sync Gateway documentation? Did I miss where the docs are, or do they not currently exist in a public repo?

Also, what would be the best way to go about reporting/fixing any potential documentation errors we might run into? 

[Paul Capestany]

Btw, just to be clear, the specific documentation I'm referring to is that which (currently) resides at http://developer.couchbase.com/guides-and-references 

[Traun Leyden]

Hey Paul,

Do you mean the server documentation, the mobile documentation, or both?

--
You received this message because you are subscribed to the Google Groups "Couchbase Mobile" group.
To unsubscribe from this group and stop receiving emails from it, send an email to mobile-couchba...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/mobile-couchbase/92d49be1-4f3f-464c-8bab-8f1f84bc64a0%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Paul Capestany]

I'm not talking about the Couchbase Server 4.0 documentation, I'm talking about the CBL + Sync Gateway docs, which I guess have this anchor link on that page → Couchbase Mobile 1.1.0

[Traun Leyden]

If you are talking about the CBL and Sync Gateway guides and API docs etc, those are all in 

https://github.com/couchbaselabs/couchbase-mobile-portal

which is currently a private repo, but there was talk about making it public at some point.  

 

To view this discussion on the web visit https://groups.google.com/d/msgid/mobile-couchbase/b59bf91f-ba42-4cbb-a3d5-b0f8c4bd8848%40googlegroups.com.

[Paul Capestany]

Ah, yeah, would be great if it was a public repo (again, in order to track diffs and raise issues/PRs for the documentation). 

Heck, pretty much everything else you guys do seems to be in public repos, don't see the harm in making https://github.com/couchbaselabs/couchbase-mobile-portal public too? :)

[Jeff Thomas]

Paul,

Thank you for your query. Here are some answers.

1. At the moment, the Couchbase Mobile documentation portal is in a private repository. I have heard others ask, “shouldn’t this be public?” We will discuss this.
2. Regarding keeping track of changes in the documentation, the Release Notes do not currently provide this information. We will also discuss that possibility. In the meantime, following is noteworthy new documentation content (in 1.1.0 and more recently):

Sync Gateway:

http://developer.couchbase.com/documentation/mobile/1.1.0/get-started/sync-gateway-overview/index.html

http://developer.couchbase.com/documentation/mobile/1.1.0/develop/guides/sync-gateway/configuring-sync-gateway/index.html

http://developer.couchbase.com/documentation/mobile/1.1.0/develop/guides/sync-gateway/server-integration/webhooks/index.html

Couchbase Lite:

http://developer.couchbase.com/documentation/mobile/1.1.0/develop/guides/couchbase-lite/tech-notes/cbl-encryption/index.html

Sync Gateway Upgrade Guide:

I expect new Sync Gateway upgrade documentation to appear with or soon after the next release of Couchbase Mobile (1.1.1). The URL for that will be the following:

http://developer.couchbase.com/documentation/mobile/1.1.1/develop/guides/sync-gateway/upgrade-guide/index.html

3. Regarding the best way to send feedback, the starting point is the blue Send Feedback button that is now in the bottom right corner of most documentation pages. Asking questions or raising issues in the forum as you have done is also fine, but I recommend using the blue button.

One other note: We just changed the appearance of the documentation website, and in some places the revised toolchain has made a bit of a mess. We will be combing the website for those issues, so you do not need to report them (unless you want to).

Thanks.

Jeff Thomas