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

Update contributor documentation #50

Open
krumts opened this issue May 13, 2024 · 1 comment
Open

Update contributor documentation #50

krumts opened this issue May 13, 2024 · 1 comment
Assignees
@krumts

Comments

@krumts
Copy link
Contributor

krumts commented May 13, 2024

The contributor documentation has to be updated:

  • the project code repository moved to github - CONTRIBUTING.md is outdated
  • the Eclipse Wiki, which contains a more detailed Contributor Guide is deprecated (and already in read only mode). The guide is referenced in the CONTRIBUTING.md

We'll need to fix the obvious inconsistencies (wrong repository), but also move all the relevant content from the Wiki.
@krumts krumts self-assigned this May 13, 2024
krumts added a commit that referenced this issue May 13, 2024
@krumts
Fixes for #50 Update contributor documentation
9fd4de6 
Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue May 13, 2024
@krumts
Fixes for #50 Update contributor documentation
25f2a73 
Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue May 13, 2024
@krumts
Fixes for #50 Update code repository in NOTICE file
43897cd 
Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue May 13, 2024
@krumts
Fixes for #50 Update code repository in NOTICE file
8068667 
Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue May 17, 2024
@krumts
Fixes for #50, Move Contributor Reference Wiki Content
6e18324 
- add a slightly updated version of the contributor reference from the old Wiki to the code repo, under /dev-doc
- add some of the referenced resources as markdown files under /dev-doc

Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue May 23, 2024
@krumts
Fixes for #50, Update CONTRIBUTING.md
e763885 
Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue May 23, 2024
@krumts
Fixes for #50, Move Contributor Reference Wiki Content
65f5023 
- add a slightly updated version of the contributor reference from the old Wiki to the code repo, under /dev-doc
- add some of the referenced resources as markdown files under /dev-doc

Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue May 23, 2024
@krumts
Fixes for #50, Update CONTRIBUTING.md
7371d83 
Signed-off-by: Krum Tsvetkov <[email protected]>
@krumts
Copy link
Contributor Author

krumts commented May 23, 2024

I think we have now a good starting point:

  • I updated (hopefully improved) the CONTRIBUTING.md
  • Moved the Contributor Reference (and some of the pages it refers to) from the deprecated Wiki under /dev-docs in the project repo.
  • also fixed the Web site to point to the new contributing docs
  • I couldn't do the changes on time, before the Wiki moves into read-only mode, so now the content is available at both places

krumts added a commit that referenced this issue Jun 6, 2024
@krumts
Fixes for #50, README.md
bbe5914 
- The README.md still pointed to the older versions of page in the Wiki,
which already moved within the code.
- fixed typos

Signed-off-by: Krum Tsvetkov <[email protected]>
krumts added a commit that referenced this issue Jun 6, 2024
@krumts
Fixes for #50, README.md
9a7e6e7 
- The README.md still pointed to the older versions of page in the Wiki,
which already moved within the code.
- fixed typos

Signed-off-by: Krum Tsvetkov <[email protected]>
@jasonk000 jasonk000 mentioned this issue Jun 13, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@krumts krumts

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@krumts