feat: add xp-clifford submodule with sidebar and config integration#39
feat: add xp-clifford submodule with sidebar and config integration#39gergely-szabo-sap wants to merge 4 commits intomainfrom
Conversation
dba9db2 to
24546b8
Compare
|
Thanks for adding What do you think, does it make sense to split the docs and put them into a I'm also looking to migrate the docs for BTP and HANA to this format:
Do you think this structure would also make sense for |
|
Hi @jn-av, Thanks for the great suggestion! I agree that restructuring the docs into a dedicated I'll make the changes there and update this PR accordingly once the submodule is ready. |
24546b8 to
d17968a
Compare
|
@jn-av, I updated the xp-clifford repo here: SAP/xp-clifford#46 and applied the changes to the current repo. |
jn-av
left a comment
There was a problem hiding this comment.
Thanks a lot for adding the documentation. Just one thing with the submodule url, and I saw that we do not specify the order of the content in the sidebar. Can we add that?
Should be possible to add by adding this to the beginning of the files in the xp-clifford repo:
---
sidebar_position: 0
---as seen here: https://github.com/SAP/crossplane-provider-btp/blob/main/docs/end-user-guides/account/subaccount.mdx?plain=1
.gitmodules
Outdated
| url = https://github.com/SAP/crossplane-provider-hana.git | ||
| [submodule "docs/xp-clifford"] | ||
| path = docs/xp-clifford | ||
| url = git@github.com:SAP/xp-clifford.git |
There was a problem hiding this comment.
Could we change this to the same format as the other ones?
https://github.com/SAP/xp-clifford.git
Add xp-clifford as a git submodule under docs/ and integrate it into the Docusaurus site: - Register submodule pointing to SAP/xp-clifford.git - Add exclude rules in docusaurus.config.js to filter out non-docs content (subdirectories, CONTRIBUTING.md, DEVELOPMENT.md) - Add xp-clifford entry to the navbar dropdown menu - Add collapsed sidebar category with autogenerated items in sidebars.js
…lder - Change exclude rules from README-root pattern to !(docs) pattern - Update sidebar dirName from xp-clifford to xp-clifford/docs - Add navbar link pointing to xp-clifford overview page - Bump xp-clifford submodule to docs-restructured commit
d17968a to
e647c38
Compare
|
@jn-av, I made the requested changes. |
Add xp-clifford as a git submodule under docs/ and integrate it into the Docusaurus site: