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

docs: remove auto-generated content #117

Merged
merged 4 commits into from Nov 8, 2022
Merged

docs: remove auto-generated content #117

merged 4 commits into from Nov 8, 2022

Conversation

sisp
Copy link
Contributor

@sisp sisp commented Nov 5, 2022

Summary

I've removed auto-generated content files in the documentation in the directory packages/documentation/docs/auto-generated/* because it's not necessary to version them via SCM and merely pollutes the repository. To prevent them from being added again in the future, I've added a .gitignore file in the documentation package that excludes this path.

See also #116 (comment).

How did you test this change?

There's not much to test. These files are generated by packages/documentation/scripts/generate-api.mjs which is run as part of the docs build process:

"build": "npm run copy-lib && npm run generate-api && docusaurus build",

Not versioning them via SCM won't prevent them from being published on the docs site.

@sisp sisp mentioned this pull request Nov 5, 2022
@sisp
Copy link
Contributor Author

sisp commented Nov 5, 2022

Interesting, a few imports can't be resolved anymore, which means some of the auto-generated docs files weren't actually being generated anymore. No error had occurred before because those obsolete files were still available in the repo.

@sisp
Copy link
Contributor Author

sisp commented Nov 5, 2022

I've removed unused/unresolvable imports for the map navigation component. But there's still the following error:

Module not found: Error: Can't resolve './../auto-generated/previews/angular/tabs-rounded.md' in 'siemens-ix/packages/documentation/docs/controls'

The auto-generated tabs-rounded.md files for React and Web Components but not for Angular. 🤔 Any idea what's wrong here?

@danielleroux danielleroux self-assigned this Nov 7, 2022
@danielleroux
Copy link
Collaborator

I've removed unused/unresolvable imports for the map navigation component. But there's still the following error:

Module not found: Error: Can't resolve './../auto-generated/previews/angular/tabs-rounded.md' in 'siemens-ix/packages/documentation/docs/controls'

The auto-generated tabs-rounded.md files for React and Web Components but not for Angular. 🤔 Any idea what's wrong here?

yep because the file is missing here: https://github.com/siemens/ix/blob/main/packages/angular-test-app/src/preview-examples

I fix this asap

@sisp
Copy link
Contributor Author

sisp commented Nov 7, 2022

The CI checks are passing now. 🎉

Copy link
Collaborator

@danielleroux danielleroux left a comment

Choose a reason for hiding this comment

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

lgtm

@danielleroux danielleroux merged commit 618c820 into siemens:main Nov 8, 2022
@sisp sisp deleted the docs/remove-auto-generated-content branch November 8, 2022 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants