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.

Sign up for GitHub

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

Jump to bottom

Add a documentation website #541

Merged
merged 7 commits into from
Jul 26, 2023
Merged

Add a documentation website #541

merged 7 commits into from
Jul 26, 2023

Conversation

jahow
Copy link
Collaborator

@jahow jahow commented Jul 25, 2023 •
edited by fgravin
Loading

This PR adds a doc website based on Vitepress.

To do:

  • write at least headers in each page
  • deploy automatically on gh-pages
  • adjust README to mention the docs folder and link to the gh-pages website

@github-actions
Copy link
Contributor

github-actions bot commented Jul 25, 2023 •
edited
Loading

Affected libs: api-metadata-converter, feature-editor, data-access-datafeeder, data-platform-e2e, util-data-fetcher, feature-dataviz, feature-record, feature-router, data-access-gn4, feature-catalog, feature-search, feature-map, feature-auth, util-app-config, util-i18n, ui-elements, ui-catalog, ui-search, ui-dataviz, ui-inputs, util-shared, ui-widgets, ui-map, util-types, ui-layout,
Affected apps: metadata-converter, metadata-editor, datafeeder, demo, datahub, webcomponents, search, map-viewer, data-platform,

  • 🚀 Build and deploy storybook and demo on GitHub Pages
  • 📦 Build and push affected docker images

@github-actions
Copy link
Contributor

github-actions bot commented Jul 25, 2023 •
edited
Loading

GitHub Pages links:

@fgravin fgravin force-pushed the doc-website branch 2 times, most recently from 91b0a64 to 5538afd Compare July 25, 2023 14:10
@fgravin fgravin marked this pull request as ready for review July 25, 2023 14:49
@fgravin fgravin force-pushed the doc-website branch 8 times, most recently from d45c050 to a0f4453 Compare July 25, 2023 16:23
@fgravin fgravin self-assigned this Jul 26, 2023
@coveralls
Copy link

coveralls commented Jul 26, 2023 •
edited
Loading

Coverage Status

coverage: 83.9% (+1.0%) from 82.915% when pulling 263c37f on doc-website into 94252f4 on main.

jahow
jahow commented Jul 26, 2023
View reviewed changes
Copy link
Collaborator Author

@jahow jahow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll just add a commit for displaying the actual version on top

README.md Outdated Show resolved Hide resolved
.github/workflows/deploy.yml
@@ -78,6 +78,9 @@ jobs:
- name: Build demo & web components
run: npm run build:demo

- name: Build docs
run: npm run docs:build -- --base=/geonetwork-ui/${{env.BRANCH_NAME}}/docs/ && mkdir -p dist/docs && mv docs/.vitepress/dist/* dist/docs
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add a link in the PR comment below to easily access the doc on the branch?

@fgravin fgravin added the documentation Improvements or additions to documentation label Jul 26, 2023
@fgravin fgravin added this to the 1.1.0 milestone Jul 26, 2023
@fgravin fgravin merged commit 048f513 into main Jul 26, 2023
5 checks passed
@fgravin fgravin deleted the doc-website branch July 26, 2023 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@fgravin fgravin

Labels
documentation Improvements or additions to documentation
Projects
geonetwork-ui roadmap
Status: Done
Milestone
1.1.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jahow @coveralls @fgravin