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

fix: connector kit structural overhaul #346

Closed

Conversation

bcronin90
Copy link
Contributor

Description

Enhances documentation process by simplifying Connector Kit documentation to a single directory (and an openapi yaml, for now).

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

These changes should not impact the two checks above. Can somebody sanity check this?

Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

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

Hey @bcronin90 ,

I really like the idea of simplifying this process :)

However, the PR is very difficult to review. The following suggestions:

  • Use the Markdownlinter and fix all issues.
  • Delete all unnecessary files (jquery.md etc)
  • please check you eca, otherwise we will get issues

Have you looked at the change locally? How does the structure look compared to the original?

@stephanbcbauer stephanbcbauer added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 29, 2023
@stephanbcbauer
Copy link
Member

@bcronin90 can this PR be closed :) Because of the ECA issue we can never ever merge it

@bcronin90
Copy link
Contributor Author

@bcronin90 can this PR be closed :) Because of the ECA issue we can never ever merge it

I'd rather we fix the issues and eventually merge it. Or should we just abort all the restructuring and keep doing all this by hand?

@stephanbcbauer
Copy link
Member

@bcronin90 can this PR be closed :) Because of the ECA issue we can never ever merge it

I'd rather we fix the issues and eventually merge it. Or should we just abort all the restructuring and keep doing all this by hand?

Yes we should definitly fix it, but with this PR we will never be able to merge it, cause at least one commit was done with an account (mail) which is not mapped to the ECA.

@bcronin90
Copy link
Contributor Author

I see. I'll need to change the commit history then, PR should be good. I'll look into it when I'm back.

@bcronin90 bcronin90 force-pushed the docs/new-connector-structure branch 2 times, most recently from ce94cba to a185fee Compare September 13, 2023 06:04
@bcronin90 bcronin90 marked this pull request as ready for review September 13, 2023 06:04
@bcronin90
Copy link
Contributor Author

bcronin90 commented Sep 13, 2023

@stephanbcbauer That should have resolved all the technical hurdles. Now we just need to be sure the contents are sound.

@bcronin90
Copy link
Contributor Author

@stephanbcbauer Are you up for a review?

Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
@stephanbcbauer
Copy link
Member

@bcronin90 will check it this week. The review will take some time, cause i have to build it locally and compare the structure with the old one. Will come back to you, after i checked it. Thanks for your patience

@stephanbcbauer
Copy link
Member

We still have to wait a little bit. There is an open discussion related to this topic #448

@bcronin90 bcronin90 closed this Nov 8, 2023
@bcronin90 bcronin90 deleted the docs/new-connector-structure branch November 8, 2023 09:21
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants