Re: [aerogear-dev] Location of Docs

@Paul That's correct. Actually I was thinking if it wouldn't be better to name it *mobile-guides* (or something similar) instead of mobile-docs? It might be confusing to have so many "docs" around. But I might be wrong, it's just an idea. I'm assuming that the release tagging for <service>-apb repo is always the I'm not sure about the tagging but @David might know the answer? JOSE MIGUEL GALLAS OLMEDO ASSOCIATE QE, mobile Red Hat <https://www.redhat.com/> M: +34618488633 <http://redhatemailsignature-marketing.itos.redhat.com/> <https://red.ht/sig> On 13 February 2018 at 09:59, Paul Wright <pwright(a)redhat.com&gt; wrote: > Thanks Jose, > I will follow up and move things appropriately after we agree on the > layout. > So what you're saying (and I like it) is: > > https://github.com/aerogear: > * mobile-docs > * <sdk>/docs > * mobile-cli/docs > > https://github.com/aerogearcatalog > * <service>-apb/docs > > I'm assuming that the release tagging for <service>-apb repo is always the > > It's unfortunate that it's split over two github organizations, but we can > 'fix that in docs' if agreed, > > Paul > > On Tue, Feb 13, 2018 at 7:49 AM, Jose Miguel Gallas Olmedo < > jgallaso(a)redhat.com&gt; wrote: > >> Hi Paul, >> >> think docs should live into their respective repos (including references >> and guides) since it's always easier for everyone to find them. >> Documentation about services in the -apb repos, SDKs in -sdk repos and so >> on. >> >> At a meeting a few weeks ago, we decided not to centralize all the docs >>> for mobile.next, because: >>> * keep docs closer to code >>> * keep docs and code versioned together >>> * allow devs update docs in same repo as they are working >>> We also decided not to create sidecar repos, eg a mobile-<service>-docs >>> repo. >> >> >> Assuming *we *as in *we, Aerogear, *several of docs from >> https://github.com/aerogear/mobile-docs/ >> <https://github.com/aerogear/mobile-docs/tree/master/services> should be >> moved into their respective repos. >> >> I however think mobile-docs would be good to have general documentation >> and how-tos that affects several services or the platform itself like >> *adding-services-to-ansible-broker.adoc*. >> >> Regards, >> >> JOSE MIGUEL GALLAS OLMEDO >> >> ASSOCIATE QE, mobile >> >> Red Hat >> >> <https://www.redhat.com/> >> >> M: +34618488633 <http://redhatemailsignature-marketing.itos.redhat.com/> >> >> <https://red.ht/sig> >> >> On 12 February 2018 at 16:24, Wojciech Trocki <wtrocki(a)redhat.com&gt; wrote: >> >>> We started writing user stories for SDK's (splitting between contributor >>> and user roles ) >>> SDK's already have solid base that will be extended over the time, with >>> similar patterns across platforms. >>> >>> *IOS: * >>> https://github.com/aerogear/aerogear-ios-sdk/tree/master/docs >>> >>> *Android *(WIP - going to be updated soon) >>> https://github.com/aerogear/aerogear-android-sdk/tree/master/docs >>> >>> > and docs for android sdk would end up in: >>> >>> https://github.com/aerogear/aerogear-android-sdk/tree/master/docs/push >>> >>> Android-sdk repository is just used for Mobile OpenShift Service Catalog >>> (AeroGear Services) >>> so push SDK may be probably in separate repository and be imported into >>> AeroGear Services SDK. >>> >>> Regards >>> >>> Wojtek >>> >>> On Mon, Feb 12, 2018 at 3:11 PM, Paul Wright <pwright(a)redhat.com&gt; wrote: >>> >>>> Hi, >>>> At a meeting a few weeks ago, we decided not to centralize all the docs >>>> for mobile.next, because: >>>> >>>> * keep docs closer to code >>>> * keep docs and code versioned together >>>> * allow devs update docs in same repo as they are working >>>> >>>> We also decided not to create sidecar repos, eg a mobile-<service>-docs >>>> repo. >>>> >>>> With that in mind, I thought that docs for push would end up in: >>>> https://github.com/aerogear/aerogear-unifiedpush-server >>>> >>>> and docs for android sdk would end up in: >>>> >>>> https://github.com/aerogear/aerogear-android-sdk >>>> >>>> but that was before I discovered that the following is the nearest >>>> thing to a 'metrics' repo that would be suitable for /docs: >>>> https://github.com/aerogearcatalog/metrics-apb >>>> >>>> However, I don't think switching org is a good experience for anyone >>>> (user or contributor), so I'm wondering if anyone has a good idea where to >>>> docs should live (relative to the code), eg: >>>> >>>> * service and sdk docs live the apb repos >>>> * service docs in apb repos, and sdk docs in 'code' repo >>>> * something else >>>> >>>> thanks, >>>> Paul >>>> >>>> -- >>>> Paul Wright >>>> Senior Technical Writer >>>> Red Hat, Waterford, Ireland >>>> gitlab: finp >>>> >>>> -- >>>> You received this message because you are subscribed to the Google >>>> Groups "Aerogear" group. >>>> To unsubscribe from this group and stop receiving emails from it, send >>>> an email to aerogear+unsubscribe(a)googlegroups.com. >>>> To post to this group, send email to aerogear(a)googlegroups.com. >>>> To view this discussion on the web visit https://groups.google.com/d/ms >>>> gid/aerogear/CALLRKFhFVgDt1KiAiJ1R22qmcP%2Be_%2Bp3g9hbYnrrRo >>>> qXFuvKzQ%40mail.gmail.com >>>> <https://groups.google.com/d/msgid/aerogear/CALLRKFhFVgDt1KiAiJ1R22qmcP%2B... >>>> . >>>> For more options, visit https://groups.google.com/d/optout. >>>> >>> >>> >>> >>> -- >>> >>> WOJCIECH TROCKI >>> >>> Red Hat Mobile <https://www.redhat.com/> >>> >>> IM: wtrocki >>> <https://red.ht/sig> >>> >>> -- >>> You received this message because you are subscribed to the Google >>> Groups "Aerogear" group. >>> To unsubscribe from this group and stop receiving emails from it, send >>> an email to aerogear+unsubscribe(a)googlegroups.com. >>> To post to this group, send email to aerogear(a)googlegroups.com. >>> To view this discussion on the web visit https://groups.google.com/d/ms >>> gid/aerogear/CAO0%2Bn%2BrSV8fD5A4fuTJiKrXoba2MpnXrSB1CLrmV%3 >>> DrYgnZ%2BCzA%40mail.gmail.com >>> <https://groups.google.com/d/msgid/aerogear/CAO0%2Bn%2BrSV8fD5A4fuTJiKrXob... >>> . >>> >>> For more options, visit https://groups.google.com/d/optout. >>> >> >> > > > -- > Paul Wright > Senior Technical Writer > Red Hat, Waterford, Ireland > gitlab: finp >