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

Improve service documentation #129

Merged
merged 10 commits into from
Oct 30, 2024

Conversation

erikbosch
Copy link
Contributor

@erikbosch erikbosch commented Oct 22, 2024

Describe your changes

This originates from that I found the current documentation somewhat limited. What I have done:

  • Updated service tutorial
  • Included the examples as source code as well, to make it easier to maintain them
  • Removed some junk from templates. I hope we do not need to implement analytics, and we have no good description on what is core features for this repository.
  • Adding some general info on how to build and test doc in main readme
  • Docsy theme updated
  • Now we also build for Pull Requests

Please visit https://erikbosch.github.io/velocitas-docs/ for a rendered version after changes applied

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code
  • If it is a core feature, I have added thorough tests.
  • Do we need to implement analytics?
  • Will this be part of a product update? If yes, please write one phrase about this update.

Copy link
Contributor

@MP91 MP91 left a comment

Choose a reason for hiding this comment

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

please check if you could move some general concepts to the title page to not copy'n'paste the same content on 2 pages. The definition of address/port comes to my mind e.g.

README.md Outdated Show resolved Hide resolved
examples/README.md Outdated Show resolved Hide resolved
Also some changes needed to make devcontainer work
@erikbosch
Copy link
Contributor Author

please check if you could move some general concepts to the title page to not copy'n'paste the same content on 2 pages. The definition of address/port comes to my mind e.g.

I wanted to let

please check if you could move some general concepts to the title page to not copy'n'paste the same content on 2 pages. The definition of address/port comes to my mind e.g.

I think it has a value that the client/server pages are quite independent, and the environment variables you need to set varies partially.

@erikbosch erikbosch requested a review from MP91 October 24, 2024 15:27
.devcontainer/Dockerfile Outdated Show resolved Hide resolved
.devcontainer/scripts/postCreateCommand.sh Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
@erikbosch erikbosch requested a review from MP91 October 25, 2024 09:45
.devcontainer/Dockerfile Show resolved Hide resolved
.devcontainer/devcontainer.json Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@erikbosch erikbosch requested a review from MP91 October 29, 2024 11:46
Copy link
Contributor

@MP91 MP91 left a comment

Choose a reason for hiding this comment

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

LGTM

Only merge after the SDK PR is merged

@erikbosch erikbosch merged commit 5a3f592 into eclipse-velocitas:main Oct 30, 2024
3 checks passed
@erikbosch erikbosch deleted the erik_service branch October 30, 2024 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants