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

refactor(docs): restructure documentation directory and framework #1882

Merged

Conversation

juliapampus
Copy link
Contributor

@juliapampus juliapampus commented Aug 25, 2022

What this PR changes/adds

  • Updates some basic markdown files (README, CONTRIBUTING, etc.): broken links, new URLs etc.
  • Adds known_friends.md
  • Moves extension, launcher and sample overview to their folder
  • Fixes links that broke during project structure refactoring
  • Restructures documentation directory to align with other EDC repos:
- docs
   - developer
      - decision-records
         - ...
         - README.md 
      - README.md
   - ...
   - templates

Why it does that

GitHub pages now have their own repo within this org.

Further notes

All links to the GitHub page are updated. Nevertheless, the current GitHub page will still be available and reference the new one. Docsify (reduced to the minimum with this PR) could be fully removed after some weeks/months.

Linked Issue(s)

Closes #1865
Closes #1844

Checklist

  • added appropriate tests?
  • performed checkstyle check locally?
  • added/updated copyright headers?
  • documented public classes/methods?
  • added/updated relevant documentation?
  • assigned appropriate label? (exclude from changelog with label no-changelog)
  • formatted title correctly? (take a look at the CONTRIBUTING and styleguide for details)

@juliapampus juliapampus added the documentation Improvements or additions to documentation label Aug 25, 2022
@juliapampus juliapampus changed the title refactor(docs): restructure documentation directory and framwork refactor(docs): restructure documentation directory and framework Aug 25, 2022
@juliapampus
Copy link
Contributor Author

New page available at: https://eclipse-dataspaceconnector.github.io/docs

Copy link
Member

@ndr-brt ndr-brt left a comment

Choose a reason for hiding this comment

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

Fantastic! I think this is actually completing issue #1844

CONTRIBUTING.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/developer/architecture/ids/README.md Outdated Show resolved Hide resolved
known_friends.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@juliapampus juliapampus merged commit 97b4d5f into eclipse-edc:main Aug 29, 2022
@juliapampus juliapampus deleted the docs/extract_documentation branch August 29, 2022 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove docsify from core repository Project structure: update documentation
3 participants