kou commented on code in PR #28:
URL: https://github.com/apache/arrow-dotnet/pull/28#discussion_r2311866770
##########
.github/workflows/test.yaml:
##########
@@ -83,3 +83,14 @@ jobs:
- name: Test
shell: bash
run: ci/scripts/test.sh $(pwd)
+
+ docs:
+ name: Build Documentation
+ runs-on: ubuntu-latest
+ timeout-minutes: 5
+ steps:
+ - name: Checkout
+ uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #
v5.0.0
+ - name: Build documentation
+ shell: bash
+ run: ci/scripts/build_docs.sh $(pwd)
Review Comment:
Can we simplify the file name?
```suggestion
run: ci/scripts/docs.sh $(pwd)
```
##########
docs/docfx.json:
##########
@@ -0,0 +1,57 @@
+{
+ "$schema":
"https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json";,
+ "metadata": [
+ {
+ "src": [
+ {
+ "src": "../src",
+ "files": [
+ "**/*.csproj"
+ ]
+ }
+ ],
+ "dest": "api",
+ "properties": {
+ "ProduceReferenceAssembly": "true"
+ }
+ }
+ ],
+ "build": {
+ "content": [
+ {
+ "files": [
+ "**/*.{md,yml}"
+ ],
+ "exclude": [
+ "_site/**"
+ ]
+ }
+ ],
+ "resource": [
+ {
+ "files": [
+ "images/*"
+ ]
+ }
+ ],
+ "output": "_site",
+ "template": [
+ "default",
+ "modern"
+ ],
+ "globalMetadata": {
+ "_appFaviconPath": "images/favicon.svg",
+ "_appLogoPath": "images/favicon.svg",
+ "_appName": "Apache Arrow .NET",
+ "_appTitle": "Apache Arrow .NET",
+ "_appFooter": "© The Apache Software Foundation",
Review Comment:
Could you also add "year"?
```suggestion
"_appFooter": "© 2018 The Apache Software Foundation",
```
##########
dev/release/rat_exclude_files.txt:
##########
@@ -20,3 +20,4 @@
*.sln
.github/pull_request_template.md
src/Apache.Arrow/Flatbuf/*
+docs/images/*
Review Comment:
> I'm not sure what the rules are on which files can be excluded, but it
seems unnecessary to have the licence header in an SVG?
Yes.
> Also, I should mention that favicon.svg was not created by me, I
downloaded it from https://arrow.apache.org/visual_identity/ and just modified
the height and width to fit in the header. Does this need to be documented
anywhere?
It's not required by our logo guideline but could you add
`docs/images/README.md` and add this note to the file for future changes? Can
we exclude `docs/images/README.md` from the `docfx` targets?
Just to confirm, your size change doesn't violate the "Please don't visually
distort the logos" part in
https://arrow.apache.org/visual_identity/#using-the-logo , right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
