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

Build Capact website using documents from external repositories #66

Open
pkosiec opened this issue Sep 17, 2021 · 0 comments
Open

Build Capact website using documents from external repositories #66

pkosiec opened this issue Sep 17, 2021 · 0 comments
Labels
area/community Relates to all community activities enhancement New feature or request

Comments

@pkosiec
Copy link
Member

pkosiec commented Sep 17, 2021

Description

For every build (from capactio/capact or capactio/website):

  1. Get docs from all source repositories (currently just capactio/capact).
    1. Probably we need to clone the repos - and clone release branches as well, to have docs for older Capact versions.
    2. We can limit ourselves to just 3 last release branches
  2. Clone website and put the docs inside docs directory
  3. Build and publish the website

AC

Configure CI for:

  • Capact repo:
    * Capact Main branch: dispatch event to website to trigger build
    * PR build for Capact main branch:
    * Build minimal version of website just to preview the documents from a given repo (e.g. capact)
  • Website
    * Website main branch build: allow to trigger it manually
    * Get docs from all source repos
    * Include docs releases (release branches)
    * Exclude internal directory from Capact (with proposals and investigations)
    * Do it as simple as possible
    * Enable running it locally (e.g. with npm start)
    * Website PR: similar to main branch
  • Make sure the solution is scalable. We will have multiple source repositories in the future.
  • Support Capact versioning - Versioning
    * Remember about best practices described there
  • For now, we don’t remove previous doc releases

Additional scope

  • Remove ToC from documents

Reason

To make it easier, we went with a simple solution to keep documentation with website content. However, this solution doesn't scale well. Ideally, it would be good to keep documentation close to actual code/component, especially if we will have multiple repositories in the future.

@pkosiec pkosiec added enhancement New feature or request area/community Relates to all community activities labels Sep 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/community Relates to all community activities enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant