Skip to content

Commit

Permalink
[Feat][Doc] Update the repository url and the docs url (apache#444)
Browse files Browse the repository at this point in the history
related apache#432 
changes include:
- repo location update: `aliabab/GraphAr` -> `apache/incubator-graphar`
- websize update: `alibaba.github.io/GraphAr` -> `graphar.apache.org`
- README.rst -> README.md

Signed-off-by: acezen <qiaozi.zwb@alibaba-inc.com>
  • Loading branch information
acezen authored and Elssky committed Oct 8, 2024
1 parent cd72036 commit 924abeb
Show file tree
Hide file tree
Showing 26 changed files with 372 additions and 342 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ labels: [Bug]
body:
- type: markdown
attributes:
value: ':stop_sign: _For support questions, please visit [GraphAr Discussions](https://github.com/alibaba/GraphAr/discussions) instead._'
value: ':stop_sign: _For support questions, please visit [GraphAr Discussions](https://github.com/apache/incubator-graphar/discussions) instead._'
- type: checkboxes
attributes:
label: 'Is there an existing issue for this?'
description: 'Please [search :mag: the issues](https://github.com/alibaba/GraphAr/issues) to check if this bug has already been reported.'
description: 'Please [search :mag: the issues](https://github.com/apache/incubator-graphar/issues) to check if this bug has already been reported.'
options:
- label: 'I have searched the existing issues'
required: true
Expand Down Expand Up @@ -83,4 +83,4 @@ body:
required: false
- type: markdown
attributes:
value: ':stop_sign: _For support questions, please visit [GraphAr Discussions](https://github.com/alibaba/GraphAr/discussions) instead._'
value: ':stop_sign: _For support questions, please visit [GraphAr Discussions](https://github.com/apache/incubator-graphar/discussions) instead._'
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@
blank_issues_enabled: false
contact_links:
- name: Questions
url: https://github.com/alibaba/GraphAr/discussions
url: https://github.com/apache/incubator-graphar/discussions
about: Search for and ask questions on our github Discussions chat.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Describe the big picture of your changes here to communicate to the maintainers

_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._

- [ ] I have read the [CONTRIBUTING](https://github.com/alibaba/GraphAr/blob/main/CONTRIBUTING.rst) doc
- [ ] I have read the [CONTRIBUTING](https://github.com/apache/incubator-graphar/blob/main/CONTRIBUTING.rst) doc
- [ ] I have signed the CLA
- [ ] Lint and unit tests pass locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on:
- cron: '00 19 * * *'
jobs:
GraphAr-ubuntu-arrow-from-source:
if: ${{ github.ref == 'refs/heads/main' && github.repository == 'alibaba/GraphAr' }}
if: ${{ github.ref == 'refs/heads/main' && github.repository == 'apache/incubator-graphar' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ jobs:

- name: Commit Doc
# TODO: open this when apache infrastructure is ready
# if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' && github.repository == 'alibaba/GraphAr' }}
# if: ${{ github.ref == 'refs/heads/main' && github.event_name == 'push' && github.repository == 'apache/incubator-graphar' }}
if: false
run: |
git config user.email github-actions@github.com
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/java.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ jobs:
- name: Run test
run: |
# Temporarily using Java 8, related issue: https://github.com/alibaba/GraphAr/issues/277
# Temporarily using Java 8, related issue: https://github.com/apache/incubator-graphar/issues/277
export JAVA_HOME=${JAVA_HOME_8_X64}
export LLVM11_HOME=/usr/lib/llvm-11
pushd java
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,20 @@ concurrency:
jobs:
release:
runs-on: ${{ matrix.os }}
if: ${{ github.repository == 'alibaba/GraphAr' }}
if: ${{ github.repository == 'apache/incubator-graphar' }}
strategy:
matrix:
os: [ubuntu-latest]

steps:
- name: Extract tag name
id: tag
if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'alibaba/GraphAr' }}
if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'apache/incubator-graphar' }}
run: echo "TAG=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT

- name: Cut a versioned release
uses: "marvinpinto/action-automatic-releases@latest"
if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'alibaba/GraphAr' }}
if: ${{ github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'apache/incubator-graphar' }}
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
automatic_release_tag: ${{ steps.tag.outputs.TAG }}
Expand Down
30 changes: 15 additions & 15 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Reporting bug
-------------------

If you've noticed a bug in GraphAr, first make sure that you are testing against
the `latest version of GraphAr <https://github.com/alibaba/GraphAr/tree/main>`_ -
your issue may already have been fixed. If not, search our `issues list <https://github.com/alibaba/GraphAr/issues>`_
the `latest version of GraphAr <https://github.com/apache/incubator-graphar/tree/main>`_ -
your issue may already have been fixed. If not, search our `issues list <https://github.com/apache/incubator-graphar/issues>`_
on GitHub in case a similar issue has already been opened.

If you get confirmation of your bug, `file a bug issue`_ before starting to code.
Expand Down Expand Up @@ -194,7 +194,7 @@ up to date with GraphAr's main branch:

.. code:: shell
$ git remote add upstream https://github.com/alibaba/GraphAr.git
$ git remote add upstream https://github.com/apache/incubator-graphar.git
$ git checkout main
$ git pull upstream main
Expand Down Expand Up @@ -267,7 +267,7 @@ Maintainers need to do the following to push out a release:
$ git tag -a v0.1.0 -m "GraphAr v0.1.0"
$ git push upstream v0.1.0
3. The release draft will be automatically built to GitHub by GitHub Actions. You can edit the release notes draft on `GitHub <https://github.com/alibaba/GraphAr/releases>`_ to add more details.
3. The release draft will be automatically built to GitHub by GitHub Actions. You can edit the release notes draft on `GitHub <https://github.com/apache/incubator-graphar/releases>`_ to add more details.
4. Publish the release.

.. the reviewing part document is referred and derived from
Expand Down Expand Up @@ -365,7 +365,7 @@ Approving a change
^^^^^^^^^^^^^^^^^^^

Any GraphAr core collaborator (any GitHub user with commit rights in the
:code:`alibaba/GraphAr` repository) is authorized to approve any other contributor's
:code:`apache/incubator-graphar` repository) is authorized to approve any other contributor's
work. Collaborators are not permitted to approve their own pull requests.

Collaborators indicate that they have reviewed and approve of the changes in
Expand Down Expand Up @@ -413,7 +413,7 @@ Continuous integration testing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

All pull requests that contain changes to code must be run through
continuous integration (CI) testing at `Github Actions <https://github.com/alibaba/GraphAr/actions>`_.
continuous integration (CI) testing at `Github Actions <https://github.com/apache/incubator-graphar/actions>`_.

The pull request change will trigger a CI testing run. Ideally, the code change
will pass ("be green") on all platform configurations supported by GraphAr.
Expand All @@ -433,30 +433,30 @@ you can submit a pull request to the related libraries implementation to impleme

.. _pre-commit: https://pre-commit.com/

.. _Code of Conduct: https://github.com/alibaba/GraphAr/blob/main/CODE_OF_CONDUCT.md
.. _Code of Conduct: https://github.com/apache/incubator-graphar/blob/main/CODE_OF_CONDUCT.md

.. _file a bug issue: https://github.com/alibaba/GraphAr/issues/new?assignees=&labels=Bug&template=bug_report.yml&title=%5BBug%5D%3A+%3Ctitle%3E
.. _file a bug issue: https://github.com/apache/incubator-graphar/issues/new?assignees=&labels=Bug&template=bug_report.yml&title=%5BBug%5D%3A+%3Ctitle%3E

.. _Open a feature request issue: https://github.com/alibaba/GraphAr/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFeat%5D
.. _Open a feature request issue: https://github.com/apache/incubator-graphar/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFeat%5D

.. _fork GraphAr: https://help.github.com/articles/fork-a-repo

.. _make a Pull Request: https://help.github.com/articles/creating-a-pull-request

.. _Github Discussions: https://github.com/alibaba/GraphAr/discussions
.. _Github Discussions: https://github.com/apache/incubator-graphar/discussions

.. _git rebasing: http://git-scm.com/book/en/Git-Branching-Rebasing

.. _interactive rebase: https://help.github.com/en/github/using-git/about-git-rebase

.. _GraphAr C++ Dependencies: https://github.com/alibaba/GraphAr/tree/main/cpp#system-setup
.. _GraphAr C++ Dependencies: https://github.com/apache/incubator-graphar/tree/main/cpp#system-setup

.. _GraphAr Spark Dependencies: https://github.com/alibaba/GraphAr/tree/main/spark#system-setup
.. _GraphAr Spark Dependencies: https://github.com/apache/incubator-graphar/tree/main/spark#system-setup

.. _Contributor License Agreement: https://cla-assistant.io/alibaba/GraphAr
.. _Contributor License Agreement: https://cla-assistant.io/apache/incubator-graphar

.. _glossary: https://chromium.googlesource.com/chromiumos/docs/+/HEAD/glossary.md

.. _format specification design: https://github.com/alibaba/GraphAr/tree/main/docs/format/file-format.rst
.. _format specification design: https://github.com/apache/incubator-graphar/tree/main/docs/format/file-format.rst

.. _implementation status: https://github.com/alibaba/GraphAr/tree/main/docs/format/status.rst
.. _implementation status: https://github.com/apache/incubator-graphar/tree/main/docs/format/status.rst
Loading

0 comments on commit 924abeb

Please sign in to comment.