Можно ли опубликовать перекрестное репо sh docusaurus из нескольких репозиториев, чтобы объединить документы вместе? - PullRequest
Новая
       61

Можно ли опубликовать перекрестное репо sh docusaurus из нескольких репозиториев, чтобы объединить документы вместе?

3 голосов
/ 23 февраля 2020

Мой вопрос: есть ли какие-либо особенности docusaurus из коробки (помимо https://github.com/facebook/docusaurus/pull/764), которые облегчат следующее? (я спрашивал это здесь, потому что их github шаблон вопроса говорит мне, что проблемы такого типа будут закрыты, и вместо этого можно задать их здесь).

В моей компании у нас есть несколько различных репозиториев, содержащих документацию по уценке, а также уценку, сгенерированную из документации исходного кода из Разнообразие языков программирования.

Я хотел бы изучить использование docusaurus для определения центрального сайта, но получить документацию из нескольких различных репозиториев.

Я хотел бы сделать это:

  • для получения централизованного поискового индекса
    • для облегчения обнаружения
  • для получения согласованной центральной темы / UX
  • публиковать sh и далее в месте слияния, чтобы нетехнические пользователи могли находить и просматривать контент, если это становится политикой компании для использования (:()
  • для сохранить все преимущества docs-close-to-code

Это структура, которую ожидает docusaurus: 

docs/            # all documentation should be placed here
website/
  blog/
  build/         # on yarn run build
  core/
    Footer.js
  package.json
  pages/
  sidebars.json
  siteConfig.js
  static/

и это структура опубликованного веб-сайта , что я хотел бы получить в итоге: 

/v1/products/{product}/{version}/{language}/{content as from docs/}
# e.g.
/v1/products/spanner/{version}/en-GB/readme.html

/v1/internal/{gh-org}/{gh-repo}/{language}/{content as from docs/}
#e.g.
/v1/my-org/my-repo/{version}/en-GB/readme.html
/v1/my-org/my-repo/{version}/en-GB/proto-generated.html

(v1 есть, потому что я предсказываю, что я что-то забыл, и это позволяет мне застраховаться от этого и внести более поздние изменения переадресация проще)

и поэтому я думаю, что это промежуточная структура, в которую мне нужно будет объединить вещи: 

docs/
  product/
    language/
      prose|generated-lang 
  gh-org/
    repo/
      language/
        prose|generated-lang
website/
  blog/
  product/
    language/
      prose|generated-lang 
  gh-org/
    repo/
      language/
        prose|generated-lang
  core/
    Footer.js
  package.json
  pages/
  product/
    language/
      prose|generated-lang 
  gh-org/
    repo/
      language/
        prose|generated-lang
  sidebars.json
  siteConfig.js
  static/
  product/
    language/
      prose|generated-lang 
  gh-org/
    repo/
      language/
        prose|generated-lang

... это вместе?

Я могу git клонировать через bash или субмодули с готовностью организовать это; это не особенно проблема. Я хочу знать, существуют ли уже такие вещи, которые позволят мне избежать необходимости делать это - например, встроенные функции инструментов docs-site, правила bazel и т. Д.

...