-
Notifications
You must be signed in to change notification settings - Fork 9
docs: Add ASF attribution #186
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
Open
simicd
wants to merge
6
commits into
apache:main
Choose a base branch
from
simicd:docs/add-asf-attribution
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3265e45
Add ASF attribution
simicd f001bb1
Add docs README
simicd bb421af
Apply suggestions from code review
simicd eff9aad
Add Flight SQL in trademark
simicd 19ef017
Add ASF header & disable prettier linting in Sphinx html component
simicd 3b56bd8
Apply suggestions from code review
simicd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,3 +31,4 @@ | |
| /package/*/apt/repositories/ | ||
| /package/*/apt/tmp/ | ||
| /package/docker/*.deb | ||
| /venv/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| <!--- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| # Arrow Flight SQL Adapter for PostgreSQL Documentation | ||
|
|
||
| This folder contains the source for the public documentation. | ||
| This is published to https://arrow.apache.org/flight-sql-postgresql/ by a GitHub Actions workflow | ||
| when changes are merged to the main branch. | ||
|
|
||
| ## Dependencies | ||
|
|
||
| It's recommended to install build dependencies and build the documentation | ||
| inside a Python `venv`. | ||
|
|
||
| To prepare building the documentation run the following on the root level of the project: | ||
|
|
||
| 1. Set up virtual environment if it was not already created | ||
| ```bash | ||
| python3 -m venv venv | ||
| ``` | ||
| 1. Activate virtual environment | ||
| ```bash | ||
| source venv/bin/activate | ||
| ``` | ||
| 1. Install documentation dependencies | ||
| ```bash | ||
| pip install -r docs/requirements.txt | ||
| ``` | ||
|
|
||
| ## Build & Preview | ||
|
|
||
| Run the provided script to build the HTML pages. | ||
|
|
||
| ```bash | ||
| rake doc:html | ||
| ``` | ||
|
|
||
| The HTML will be generated into a `doc/build` directory. | ||
|
|
||
| Preview the site on Linux by running this command. | ||
|
|
||
| ```bash | ||
| firefox doc/build/index.html | ||
| ``` | ||
|
|
||
| ## Release Process | ||
|
|
||
| This documentation is hosted at https://arrow.apache.org/flight-sql-postgresql/ | ||
|
|
||
| When the PR is merged to the `main` branch of the Apache Arrow Flight SQL adapter for PostgreSQL | ||
| repository, a [GitHub Actions workflow](https://github.com/apache/arrow-flight-sql-postgresql/blob/main/.github/workflows/doc.yaml) which: | ||
|
|
||
| 1. Builds the HTML content | ||
| 2. Pushes the HTML content to the [`asf-site`](https://github.com/apache/arrow-flight-sql-postgresql/tree/asf-site) branch in this repository. | ||
simicd marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| The Apache Software Foundation provides https://arrow.apache.org/, | ||
| which serves content based on the configuration in | ||
| [.asf.yaml](https://github.com/apache/arrow-flight-sql-postgresql/blob/main/.asf.yaml), | ||
simicd marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| which specifies the target as https://arrow.apache.org/flight-sql-postgresql/. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| <!-- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
| /* eslint-disable prettier/prettier */ | ||
|
|
||
| {# Display the trademark information (which is defined in conf.py html_context). #} | ||
| {% if show_copyright and trademark %} | ||
| <p class="trademark"> | ||
| <div class="footer-item"> | ||
| {% for trademark_line in trademark %} | ||
| <p>{{ trademark_line }}</p> | ||
| {% endfor %} | ||
| </div> | ||
| </p> | ||
| {% endif %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.