Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

setup waku.org and waku.guide websites #15

Open
6 of 30 tasks
fryorcraken opened this issue Jul 29, 2022 · 5 comments
Open
6 of 30 tasks

setup waku.org and waku.guide websites #15

fryorcraken opened this issue Jul 29, 2022 · 5 comments
Assignees

Comments

@fryorcraken
Copy link
Contributor

fryorcraken commented Jul 29, 2022

Definition of Done

| Hosting domain       | GitHub Repo               | Framework | Content                           |
| -------------------- | ------------------------- | --------- | --------------------------------- |
| waku.org             | waku-org/waku.org         | acid-info | Waku landing page                 |
| waku.guide           | waku-org/waku.guide       | acid-info | General Waku Doc (md files)       |
| js.waku.guide        | waku-org/js.waku.guide    | hugo      | JS Waku Doc (md files)            |
| go.waku.guide        | waku-org/go.waku.guide    | acid-info | Go Waku Doc (md files)            |
| nim.waku.guide        | waku-org/nim.waku.guide    | acid-info | Nwaku Doc (md files)            |
| js.waku.org          | waku-org/js-waku          | TypeDoc   | JS API Doc (generated html files) |
| examples.waku.org    | waku-org/js-waku-examples | None      | React/HTML/etc websites           |

Tasks

tasks grouped together are sequential


  • Verify domains on GitHub orga (waku.org, waku.guide)

  • Move waku.org repo to waku-org orga
  • Ensure publishing works @amirhouieh

  • Fork acid-info/logos-sites-content-repo-template to waku.guide
  • Ensure publishing works @amirhouieh
  • Add doc content to waku.guide (copied from waku.org and docs.wakuconnect.dev)
  • Point from waku.org to waku.guide for docs, remove doc content from waku.org

  • Move docs.wakuconnect.dev to waku.org/js.waku.guide
  • Setup Jenkins for waku.org/js.waku.guide to publish to js.waku.guide
  • add link in waku.guide to js.waku.guide
  • add link in waku.org to js.waku.guide (if it makes sense)
  • Redirect docs.wakuconnect.dev to waku.guide

  • Fork acid-info/logos-sites-content-repo-template to go.waku.guide
  • Add doc content from go-waku to go.waku.guide
  • Add link in waku.org to go.waku.guide (if it makes sense)
  • Add link in waku.guide to go.waku.guide
  • Point go-waku readme to go.waku.guide
  • Remove doc content from go-waku repo

  • Fork acid-info/logos-sites-content-repo-templateto nim.waku.guide
  • Add doc content from nwaku to nim.waku.guide
  • Add link in waku.org to nim.waku.guide (if it makes sense)
  • Add link in waku.guide to nim.waku.guide
  • Point nwaku readme/doc to nim.waku.guide
  • Remove doc content from go-waku repo

  • Move js-waku to waku-org orga
  • Change Jenkins to publish generated doc to js.waku.org instead of js-waku.wakuconnect.dev
  • Add link in js.waku.guide to js.waku.org
  • Add link to js-waku.guide to js-waku README

  • Move waku-gnosis repo to waku-org
  • Adjust hosting url
@fryorcraken fryorcraken self-assigned this Jul 29, 2022
@jakubgs
Copy link
Contributor

jakubgs commented Jul 29, 2022

I've added the necessary validation TXT records for waku.org and waku.guide: https://github.com/status-im/infra-misc/commit/ab8a10a6

image

This might take an hour or a few though.

@jakubgs
Copy link
Contributor

jakubgs commented Jul 29, 2022

And they are verified:

image

@amirhouieh
Copy link
Contributor

@fryorcraken we wont use Acid Info framework for waku.guide & *.waku.guide. As discussed we are going to use a fully specialized framework. We have two solid options

  1. https://docusaurus.io/
  2. https://squidfunk.github.io/mkdocs-material/

We prefer number 1 because it is an exact match in terms of tech stack (ReactJs + Typescript) with what we use at branding. It also supports MDX which enables you to have way more control over the content and its structure.

@amirhouieh
Copy link
Contributor

@fryorcraken I would suggest moving all tasks related to documentation websites to their own repos, what do you think?

@fryorcraken
Copy link
Contributor Author

@fryorcraken I would suggest moving all tasks related to documentation websites to their own repos, what do you think?

Yes, happy to clean up once waku.guide is shipped. It's just that part of the task is creating said repo.
I am happy to move the tasks to the repos once they are open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

3 participants