bounties
bounties copied to clipboard
rchain
publish RChain architecture document in rchain.coop domain
Let's not just do sharecropping on readthedocs but publish it under our own domain.
See alternate domains.
@ian-bloom would you please make the CNAME (perhaps arch-doc.rchain.coop)? Do you know who administers http://rchain-architecture.readthedocs.io?
p.s. RChain Architecture | Read The Docs shows ed.eykholt Jos.Denmark and rchain as owners.
@dckc maybe this could be a cool place to start setting up a Jekyll installation?
That way, everyone can already have a look at how suitable (or not) that would be for the main marketing website, too.
This seems like a safe "test case"
Jekyll might be cool, but it introduces steps that aren't needed here. The workflow through readthedocs is already working. All we need to do is publish the result under our domain.
@ian-bloom , I have been given admin rights in readthedocs; all we need is the CNAME. Would you like to set up arch-doc.rchain.coop as a CNAME for readthedocs.io?
@dckc Not working. arch-doc.rchain.coop sends you to http://docs.mio-lang.org/zh_CN/latest/
Perhaps this is related to Issue 'Read the Docs' Builds Failing #18
The admin of the architecture-docs is @pyrocto. He has installed a Github/ReadTheDocs service integration, and his ReadTheDocs account should be the only one with Admin rights to assign a Custom Domain.
RChain Organization has more than one ReadTheDocs enabled repo. arch-doc.rchain.coop refers to a specific document. Wouldn't it be preferable to use a more generic subdomain if we plan to make further use of ReadTheDocs?
For Example:
- https://rtd.rchain.coop/rchain-architecture
- https://rtd.rchain.coop/mobile-process-calculi-for-programming-the-new-blockchain
Now that I've done my part at readthedocs, it seems to work fine: http://arch-doc.rchain.coop/ -> http://arch-doc.rchain.coop/en/latest/
RChain Organization has more than one ReadTheDocs enabled repo ... Wouldn't it be preferable to use a more generic subdomain
Yes, that does look useful.
I was going to say "RTD doesn't work that way" but now i see a Subprojects feature.
"rtd" is, to some extent, embedding inessential mechanical details in the URL, but it's sufficiently opaque that we could just change the way we read it if we changed back ends. The convention is actually docs.rchain.coop, but I'm not sure we want to go with that. I suggested tech.rchain.coop. But I don't feel strongly about it.
@pmoorman hold off on updating links while we think this over...
I believe that, for a lot of technical people, 'readthedocs' is a kind of brand and engenders respect. So while I'm fully for having the arch doc in our own domain, we could also spell it out in a subdomain like:
https://readthedocs.rchain.coop
Which then may subdivide into: https://readthedocs.rchain.coop/rchain-architecture/en/latest/ https://readthedocs.rchain.coop/etc
@kitblake @dckc ping me when this is decided on, and I'll fix the link on the website
I have found the way to fixed the build error mentioned above. https://github.com/rchain/architecture-docs/issues/18
Reviewing issues assigned to me... wondering if we can close this one, now that the Chinese translation is all integrated... ah... several have advocated expanding the scope to include Mobile process calculi for programming the blockchain.
Oddly, the first Google hit for that title is actually a Dec 2016 medium post. Is it important to invest in that document going forward? A link from the FAQ suggests it is. Sigh.
@ian-bloom who administers the rdt project for mobile-process-calculi-for-programming-the-new-blockchain ? Would you ask them to add me? I guess I'm willing to set it up under docs.rchain.coop along with the architecture document, provided I am made an administrator of the rtd project.
@PatrickM727 asked that we migrate from readthedocs to developer.rchain.coop for SEO.
http://arch-doc.rchain.coop/ is now the top search hit for "RChain Architecture", at least in some cases.