docs: update the READMEs and init mkDocs (DSP-1298) #271

kilchenmann · 2021-01-29T09:59:01Z

This PR brings back the dsp-ui documentation from dsp-docs incl. little refactoring (s. description on youtrack). The update of the content and description of each component has to be done in a separate task.
A first version of the documentation is already available on gh page: https://dasch-swiss.github.io/dsp-ui-lib/

…wiss/dsp-ui-lib into wip/dsp-1298-update-docs

flavens

careful, there is a mix of "DSP-UI-LIB" and "DSP-UI" across different files
see the other comments
the correction of the language typos is probably incomplete

docs/README.md

docs/how-to-contribute/index.md

flavens · 2021-02-01T13:06:31Z

docs/how-to-contribute/index.md

+
+## Demo Application (Playground)
+
+### Adding New Component to the Demo Application


why having all the words in camelcase in all the titles?

@flavens it's how titles are written in English but we should be consistent. The other docs do not have this capitalization. I would suggest using this form of capitalization and changing the titles in the other docs to be the same.

I suggest to do these changes in a separate refactor task (by someone who knows the english language better than me). We have to rewrite and update the "how-to-use"-documentation anyway.

mdelez

My review may have gotten a little out of hand...let me know if you would like me to help you out with these changes.

README.md

docs/README.md

docs/how-to-use/search/index.md

docs/how-to-use/search/search-panel.md

docs/how-to-use/viewer/index.md

docs/how-to-use/viewer/search-results.md

kilchenmann · 2021-02-02T05:16:10Z

careful, there is a mix of "DSP-UI-LIB" and "DSP-UI" across different files
see the other comments
the correction of the language typos is probably incomplete

This is the big question: The repo's called dsp-ui-lib, but we publish it as dsp-ui. The main README will also be used for the published version (e.g. on npm). What do you suggest @flavens: DSP-UI-LIB or DSP-UI?
I prefer to use the term DSP-UI.

Btw.: the term DSP-UI-LIB occurs 9 times in 4 files; DSP-UI occurs 36 times in 11 files.

EDIT: I updated everything to DSP-UI

kilchenmann · 2021-02-02T06:25:04Z

the correction of the language typos is probably incomplete

Yes, this should be done (soon) in a separate refactor task.

flavens · 2021-02-02T10:36:26Z

This is the big question: The repo's called dsp-ui-lib, but we publish it as dsp-ui. The main README will also be used for the published version (e.g. on npm). What do you suggest @flavens: DSP-UI-LIB or DSP-UI?
I prefer to use the term DSP-UI.

Btw.: the term DSP-UI-LIB occurs 9 times in 4 files; DSP-UI occurs 36 times in 11 files.

I do not mind, as long as we stay consistent!

flavens

the other things to edit can be done in an other PR as mentioned > approved

mdelez

You can assign me to a new PR about fixing typos :)

kilchenmann and others added 30 commits January 28, 2021 15:20

docs: add mkDocs

e979c77

docs: copy from dsp-docs

a3cd7ae

docs(contribution): mv contribution file to mkdocs

5265164

docs(contribution): mv design docs to mkdocs

23f2813

docs(structure): refactor file structure and content

82b3000

docs(gh-ci): build and deploy docs

af36970

Merge branch 'main' into wip/dsp-1298-update-docs

4c3cf08

docs(gh-ci): bug fix in workflow

e1fb67d

Merge branch 'wip/dsp-1298-update-docs' of https://github.com/dasch-s…

febc31a

…wiss/dsp-ui-lib into wip/dsp-1298-update-docs

docs(structure): refactor file structure and content

f837fca

docs: set index

2d19043

docs: update main README

9036608

docs(mkdocs): Update config

1a381d0

docs: update mkdocs README

06adf6f

chore: update build-lib process

8b4c254

docs: clean up and refactor

fc244b1

docs: restructure file structure

4072f5a

docs(style): update theme

fc5bacd

docs: move lib's README to documentation

49f9f71

docs(config): update mkdocs conf

ab709fe

docs: update README

dfd26a5

docs(config): add revision date plugin

c20139b

docs: update mkdocs README

9bf7750

docs(contribution): add mkdocs documentation

c909031

docs: refactor old content

4a56552

chore(gh-ci): activate docs deployment once

6021310

docs(mkdocs): updata mkdocs README

bfa1ef6

docs(gh-ci): add mkdocs plugins to deploy docs

b16f7d5

chore(gh-ci): fix docs deployment

6397125

chore(gh-ci): fix docs deployment

487cd84

kilchenmann added 6 commits January 30, 2021 09:28

docs(contribution): update release process

9dc2c7e

chore(gh-ci): better title

5b2802a

docs(README): update dead links

a4684a4

docs(config): update copyright info

d6c446c

chore(gh-ci): deploy docs once again

1d92cce

chore(gh-ci): run docs deployment on release only

14abcad

kilchenmann self-assigned this Jan 30, 2021

kilchenmann added the documentation Improvements or additions to documentation label Jan 30, 2021

kilchenmann requested review from mdelez and flavens January 30, 2021 08:57

flavens requested changes Feb 1, 2021

View reviewed changes

mdelez requested changes Feb 1, 2021

View reviewed changes

kilchenmann added 9 commits February 2, 2021 06:32

docs(mkdocs): update README

f10c104

docs: consistent use of the term dsp-ui

f8f1fcd

docs: consequent use of github

455427d

docs: update main README

11f8cb8

docs(mkdocs): update docs README

2d9176a

docs(contribution): replace knora by dsp-api

bdba1f9

docs: replace kui by dsp

db4741f

docs: replace Kui by Dsp

648031b

docs: refactor and fix typo

177e579

kilchenmann requested review from flavens and mdelez February 2, 2021 06:30

flavens approved these changes Feb 2, 2021

View reviewed changes

mdelez approved these changes Feb 2, 2021

View reviewed changes

kilchenmann merged commit b436a31 into main Feb 2, 2021

kilchenmann deleted the wip/dsp-1298-update-docs branch February 2, 2021 12:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update the READMEs and init mkDocs (DSP-1298) #271

docs: update the READMEs and init mkDocs (DSP-1298) #271

kilchenmann commented Jan 29, 2021 •

edited

flavens left a comment

flavens Feb 1, 2021

mdelez Feb 1, 2021

kilchenmann Feb 2, 2021 •

edited

mdelez left a comment

kilchenmann commented Feb 2, 2021 •

edited

kilchenmann commented Feb 2, 2021

flavens commented Feb 2, 2021

flavens left a comment

mdelez left a comment


		## Demo Application (Playground)

		### Adding New Component to the Demo Application

docs: update the READMEs and init mkDocs (DSP-1298) #271

docs: update the READMEs and init mkDocs (DSP-1298) #271

Conversation

kilchenmann commented Jan 29, 2021 • edited

flavens left a comment

Choose a reason for hiding this comment

flavens Feb 1, 2021

Choose a reason for hiding this comment

mdelez Feb 1, 2021

Choose a reason for hiding this comment

kilchenmann Feb 2, 2021 • edited

Choose a reason for hiding this comment

mdelez left a comment

Choose a reason for hiding this comment

kilchenmann commented Feb 2, 2021 • edited

kilchenmann commented Feb 2, 2021

flavens commented Feb 2, 2021

flavens left a comment

Choose a reason for hiding this comment

mdelez left a comment

Choose a reason for hiding this comment

kilchenmann commented Jan 29, 2021 •

edited

kilchenmann Feb 2, 2021 •

edited

kilchenmann commented Feb 2, 2021 •

edited