feat: add initial documentation website #237
Conversation
|
|
|
|
|
@Fokko, could you please take a look at this? |
Fokko
left a comment
Fokko
left a comment
There was a problem hiding this comment.
Left some small comments, but I think this looks great for a first version! Very comprehensive, thanks @nullccxsy for working on this 🙌
|
We still see the CI error: https://github.com/apache/iceberg-cpp/actions/runs/17964469116/job/51094065180?pr=237 @Fokko Do you have any idea? |
|
@wgtmac I'm not sure, maybe the action is not allowed by the ASF. I would take a look at how we do it at PyIceberg: https://github.com/apache/iceberg-python/blob/main/.github/workflows/python-release-docs.yml Here we just copy the output to the pages branch and set the |
mkdocs/docs/index.md
Outdated
| We aim for high test coverage. Run tests with coverage: | ||
|
|
||
| ```bash | ||
| cmake -S . -B build -DICEBERG_BUILD_COVERAGE=ON |
There was a problem hiding this comment.
We don't have this yet. Perhaps an AI illusion?
|
remote: {"auth_status":"access_denied_to_user","body":"Permission to apache/iceberg-cpp.git denied to github-actions[bot]."} |
nullccxsy
force-pushed
the
website
branch
2 times, most recently
from
f0cc014 to
1428b31
Compare
|
@wgtmac Could you look at this? It seems that there is no issue. |
|
@nullccxsy Thanks for the update! I'll take a look shortly. |
|
It is strange that deploying docs still hit error below but the workflow does not fail. |
- Replace Doxygen with MkDocs and Material theme - Add documentation pages (home, installation, quickstart, config, examples) - Set up GitHub Actions for automatic deployment - Note: This is a demo website with placeholder content
- Add MkDocs-based documentation website with Material theme - Include basic pages: Home, Configuration, Examples, Contributing, Releases - Add API documentation structure for Table, Catalog, Schema, Types, and Table Scan - Add build script for local documentation generation - Add GitHub Actions workflow for automatic deployment to GitHub Pages - Configure custom domain cpp.iceberg.apache.org Note: This is a demo version with placeholder content that needs further refinement.
- Added Doxygen configuration file for API documentation generation. - Introduced a build script for MkDocs documentation. - Removed outdated documentation files and replaced them with a structured MkDocs setup.
|
Those commands havn't been verified. I will verify this on my Ubuntu and submit a pull request. |
zhjwpku
left a comment
zhjwpku
left a comment
There was a problem hiding this comment.
LGTM, thanks for working on this.
|
Let me merge this to see what's going on. Thanks @nullccxsy for working on it and @Fokko @zhjwpku for the review! |
|
I got |
|
Is there any error? |
This site can’t be reached The above is from my browser, no other info. |
|
This may need @wgtmac to check if there were any errors during the merge. |
|
We need a successful push to main branch with changes in src or docs folder to trigger it. @zhjwpku @nullccxsy |
So it will be triggered the next time you merge a commit due to the missing of '|'. |
|
It didn't because I have only changed the .github folder. |
Sounds good, let's wait for the next commit ;) |
|
Yes, that's weird. I have checked https://github.com/apache/iceberg-cpp/actions/runs/18689491146/job/53291125293 and it looks good. @kevinjqliu Do you have any insight on this? |
|
I think apache infra needs to add a CNAME for this to work. Created https://issues.apache.org/jira/browse/INFRA-27352 |
|
I've tried to search some evidence from the ASF website but may have overlooked this. Thanks @kevinjqliu for the help! |
5 participants
Note: This is a demo version with placeholder content that needs further refinement.