diplodoc-platform / documentation-template

documentation template with support for codespaces and hot reload via dev server
11 stars 0 forks source link

:question: Quickstart version local and codebase online does not same. How to config? #4

Open ilentt opened 7 months ago

ilentt commented 7 months ago

Hello,

I try quick start documentation-template both version local and codebase online but they are not same.

There are some issues:

  1. Online version auto redirect to en version when access root domain, but local does not. image

  2. Online version has top menu include icon setting, search box feature but local does not image

  3. Online version has section was the article helpful? at the bottom and top at right sidebar, but local does not New Project

  4. I18n does not work on local version. Russian language still remain in English interface New Project

I try copy css and config from diplodoc example but it don't work.

image

I also want add logo, menu and language feature on top menu bar.

image

I copy navigation config from from diplodoc example but it also don't work.

image

And the last issue, I need deploy into gitlab with my own domain. How can I do that?

Thanks

martyanovandrey commented 5 months ago

Hello,

1) we recently fixed this, a new version with fixes will be released within a week 2) there is no search in the local assembly, we are thinking about adding it in the future

icon can be added via navigation in toc.yaml https://github.com/diplodoc-platform/docs/blob/master/en/toc.yaml#L10 3) thats intended, locally you don't have option to send somewhere feedback 4) we already fixed this on our latest cli versions

I copy navigation config from from diplodoc example but it also don't work.

what version of cli are you using ? you may need to update it

And the last issue, I need deploy into gitlab with my own domain. How can I do that?

We do not provide ready-made solutions for assembling in Gitlab, but you can try to use our tasks in GitHub yourself and make similar ones in Gitlab

https://github.com/diplodoc-platform/docs-build-action https://github.com/diplodoc-platform/docs-build-static-action

ilentt commented 5 months ago

Hello

Thank you for your response.

If feature search and feedback content does not available on local, how can you make adjust and ensure that your features work well before go live?

About logo and icon language on top menu bar, as my 2nd screenshot vscode ide in previous post, you can see I already added navigation and header into toc.yaml which config copy from https://github.com/diplodoc-platform/docs/blob/master/en/toc.yaml#L10 as you suggest. But It does not work. I don't know what I was wrong in this step.

About feature I18n translate language from Russian to English. I only clone repo documentation-template and execute following instruction without install cli package before.

> git clone git@github.com:diplodoc-platform/documentation-template.git

> cd documentation-template

> npm start

> listening on 0.0.0.0:8000

After you ask me about cli version I tried install cli follow instruction and here is my log

image

Then execute command

npm run start -- -i ./docs -o ./docs-html -v "{\"name\":\"Alice\"}"

I dont understand what argument -v "{\"name\":\"Alice\"}" is meaning.

And here are log after execute above command

> @diplodoc/documentation-template@0.0.0 start
> npm run build:docs && node scripts/serve.js -i ./docs -o ./docs-html -v {"name":"Alice"}

> @diplodoc/documentation-template@0.0.0 build:docs
> yfm --input docs --output docs-html

COPY Copying file _assets/style/custom.css
COPY Copying file en/about.md
COPY Copying file en/anotherpage.md
COPY Copying file en/index.yaml
COPY Copying file en/new-page.md
COPY Copying file en/page.md
COPY Copying file en/sub-section/content.md
COPY Copying file en/sub-section/index.yaml
COPY Copying file en/sub-section/toc.yaml
COPY Copying file en/toc.yaml
COPY Copying file vi/about.md
COPY Copying file vi/anotherpage.md
COPY Copying file vi/index.yaml
COPY Copying file vi/new-page.md
COPY Copying file vi/page.md
COPY Copying file vi/sub-section/content.md
COPY Copying file vi/sub-section/index.yaml
COPY Copying file vi/sub-section/toc.yaml
COPY Copying file vi/toc.yaml
PROC Processing file en/sub-section/toc.yaml
PROC Processing file en/toc.yaml
PROC Processing file vi/sub-section/toc.yaml
PROC Processing file vi/toc.yaml
INFO Linting finished: en/sub-section/content.md
INFO Linting finished: en/about.md
INFO Linting finished: en/page.md
INFO Linting finished: en/anotherpage.md
INFO Linting finished: en/new-page.md
INFO Linting finished: en/sub-section/content.md
INFO Linting finished: vi/sub-section/content.md
INFO Linting finished: vi/about.md
INFO Linting finished: vi/page.md
INFO Linting finished: vi/anotherpage.md
INFO Linting finished: vi/sub-section/content.md
PROC Processing file en/sub-section/content.md
INFO Processing finished: en/sub-section/content.md
PROC Processing file en/sub-section/index.yaml
INFO Processing finished: en/sub-section/index.yaml
PROC Processing file en/about.md
INFO Processing finished: en/about.md
PROC Processing file en/page.md
INFO Processing finished: en/page.md
PROC Processing file en/anotherpage.md
INFO Processing finished: en/anotherpage.md
PROC Processing file en/new-page.md
INFO Processing finished: en/new-page.md
PROC Processing file en/sub-section/content.md
INFO Processing finished: en/sub-section/content.md
PROC Processing file en/index.yaml
INFO Processing finished: en/index.yaml
PROC Processing file vi/sub-section/content.md
INFO Processing finished: vi/sub-section/content.md
PROC Processing file vi/sub-section/index.yaml
INFO Processing finished: vi/sub-section/index.yaml
PROC Processing file vi/about.md
INFO Processing finished: vi/about.md
PROC Processing file vi/page.md
INFO Processing finished: vi/page.md
PROC Processing file vi/anotherpage.md
INFO Processing finished: vi/anotherpage.md
PROC Processing file vi/sub-section/content.md
INFO Processing finished: vi/sub-section/content.md
PROC Processing file vi/index.yaml
INFO Processing finished: vi/index.yaml
COPY Copying file _assets/style/custom.css
cp: no such file or directory: /DiploDoc/documentation-template/docs-html/.tmp_output/.*

Build time: 151.701ms

building documentation
cp: no such file or directory: /DiploDoc/documentation-template/docs-html/.tmp_output/.*
injecting sse into html
serving on: http://0.0.0.0:8000

Final, check result again at localhost:8000/en, nothing change. Russian language still remain in English interface.

Note that I do everything above on local, so I don't add .env config.

I don't know what I was wrong in above step, could you please give me a feedback?