Skip to content

Commit

Permalink
Bulk Lint updates
Browse files Browse the repository at this point in the history
Change-Id: I9665829957416c9aca6c454c6dc52aa1d0baca70
GitOrigin-RevId: bae0baf378002b392cc3117a29943234eabc5420
  • Loading branch information
anantdamle committed May 15, 2024
1 parent 67bf06f commit 8426ea2
Show file tree
Hide file tree
Showing 163 changed files with 2,376 additions and 2,378 deletions.
14 changes: 2 additions & 12 deletions .github/workflows/deploy-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
# 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
Expand All @@ -20,21 +20,17 @@
#

name: Deploy documentation to GitHub Pages

on:
push:
branches: ["main"]

#
# Allow running this workflow manually from the Actions tab
#
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
#
# Allow only one concurrent deployment, skipping runs queued between the run
Expand All @@ -43,33 +39,27 @@ concurrency:
#
group: "pages"
cancel-in-progress: false

jobs:
deploy-site:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.x

- name: Build site
working-directory: docs
run: ./mkdocs.sh build --site-dir build/public

- name: Set up Pages
if: github.ref == 'refs/heads/main'
uses: actions/configure-pages@v5

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
if: github.ref == 'refs/heads/main'
with:
path: 'docs/build/public'

- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
uses: actions/deploy-pages@v4
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ again.
All submissions, including submissions by project members, require review. We
use Code Review Workflow of the Gerrit Code Review System for this purpose.

All changes should be submitted to https://cloud-solutions.googlesource.com/the-repo-public to get reviewed.
All changes should be submitted to <https://cloud-solutions.googlesource.com/the-repo-public> to get reviewed.

Consult [Gerrit User Guide](https://gerrit-documentation.storage.googleapis.com/Documentation/3.8.1/intro-user.html#code-review) for more
information on howto upload a change.
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,39 @@ This repository consolidates a number of open source projects in the form of sol

> Note: It is not recommended to run the tools or solutions inside this repository in production environment. Proceed with caution.

## Getting Started

To get started, clone this repository and install the dependencies:

Use code with caution. Learn more
```

```shell
git clone https://cloud-solutions.googlesource.com/the-repo
cd the-repo
```

All different solutions, PoC, or tools will be hosted under each respective folders under `projects/` folder

```
```shell
cd projects
```

### Adding New Projects
For now, only the owners and approved contributors allowed to add new projects through PR process.


For now, only the owners and approved contributors allowed to add new projects through PR process.

## Deployment

To deploy the each projects in this repository, you will need to go to each projects' subfolder and follow its README.md file for installation/deployment guide. Each tools or solutions exists indenpendently in isolation under each subfolder under the `projects/` folder and can be configured to run the necessary build and deployment steps for each project.

## Contributing

We welcome contributions to this repository. If you have an idea for a new project, or if you would like to improve an existing project, please check `CONTRIBUTING.md` first.

## Questions & Feedback

Do you have trouble installing or setting up a project. Please email the owners (check `OWNERS` file). Your feedback is important for us.

## Disclaimer

The projects in this repository are not official Google products.
2 changes: 1 addition & 1 deletion docs/common/images/cloud.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8426ea2

Please sign in to comment.