Skip to content

Commit

Permalink
fix wording and link on readme (#878)
Browse files Browse the repository at this point in the history
* fix wording and link on readme

Signed-off-by: pxp928 <parth.psu@gmail.com>

* fix lint issues

Signed-off-by: pxp928 <parth.psu@gmail.com>

---------

Signed-off-by: pxp928 <parth.psu@gmail.com>
  • Loading branch information
pxp928 committed May 22, 2023
1 parent 9ca8e1c commit 8e94827
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 19 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

Refer to the [GraphQL Guide](./demo/graphql/GraphQL.md) to go through a setup.
Optionally, you can also consult [docker compose
documentation](./docs/Compose.md).
Optionally, you can also consult
[docker compose documentation](./docs/Compose.md).

## Contributor License Agreement

Expand Down
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
**Note:** GUAC is under active development - if you are interested in
contributing, please look at [contributor guide](CONTRIBUTING.md).

[Graph for Understanding Artifact Composition (GUAC)](https://guac.sh/) aggregates software security
metadata into a high fidelity graph database—normalizing entity identities and
mapping standard relationships between them. Querying this graph can drive
higher-level organizational outcomes such as audit, policy, risk management, and
even developer assistance.
[Graph for Understanding Artifact Composition (GUAC)](https://guac.sh/)
aggregates software security metadata into a high fidelity graph
database—normalizing entity identities and mapping standard relationships
between them. Querying this graph can drive higher-level organizational outcomes
such as audit, policy, risk management, and even developer assistance.

Conceptually, GUAC occupies the “aggregation and synthesis” layer of the
software supply chain transparency logical model:
Expand All @@ -26,17 +26,20 @@ A few examples of questions answered by GUAC include:

Our [documentation](https://docs.guac.sh/) is a good place to get started.

We have various [demos use cases](https://docs.guac.sh/guac-use-cases/) that you can take a look.
We have various [demos use cases](https://docs.guac.sh/guac-use-cases/) that you
can take a look.

Starting the GUAC services with our [docker compose quickstart](https://docs.guac.sh/setup/).
Starting the GUAC services with our
[docker compose quickstart](https://docs.guac.sh/setup/).

## Architecture

Here is an overview of the architecture of GUAC:

![image](https://user-images.githubusercontent.com/3060102/235186368-995784eb-7ef2-43e6-b560-17d6014553ca.png)

For an in-depth view and explanation of components of the GUAC Beta, please refer to [how GUAC works](https://docs.guac.sh/how-guac-works/).
For an in-depth view and explanation of components of the GUAC Beta, please
refer to [how GUAC works](https://docs.guac.sh/how-guac-works/).

## Supported input formats

Expand All @@ -50,7 +53,9 @@ For an in-depth view and explanation of components of the GUAC Beta, please refe
Note that GUAC uses software identifiers standards to help link metadata
together. However, these identifiers are not always available and heuristics
need to be used to link them. Therefore, there may be unhandled edge cases and
errors occurring when ingesting data. We appreciate if you can create an [issue](https://github.com/guacsec/guac/issues) via the "Report for data quality issues and ingestion bugs" issue template.
errors occurring when ingesting data. We appreciate it if you could create a
[data quality issue](https://github.com/guacsec/guac/issues) if you encounter
any errors or bugs with ingestion.

## Additional References

Expand All @@ -61,7 +66,7 @@ errors occurring when ingesting data. We appreciate if you can create an [issue]
## Communication

For more information on how to get involved in the community, mailing lists and
metings, please refer to our [community page](https://guac.sh/community/)
meetings, please refer to our [community page](https://guac.sh/community/)

For security issues or code of conduct concerns, an e-mail should be sent to
guac-maintainers@googlegroups.com.
Expand Down
14 changes: 7 additions & 7 deletions docs/Compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ components. For example, the [GUAC GraphQL demo](graphql-demo.md) showcases the
graphQL server in isolation.

However, that's just one component of GUAC! In order to get the most value out
of GUAC (for example, augmenting documents with aditional data), we need to take
advantage of the additional components of GUAC!
of GUAC (for example, augmenting documents with additional data), we need to
take advantage of the additional components of GUAC!

The full GUAC component deployment is a set of asynchronous services that
combine to form a robust and scaleable pipeline. This is represented by the area
in green in the diagrom below. In some of our [demos](demos/), you may have seen
combine to form a robust and scalable pipeline. This is represented by the area
in green in the diagram below. In some of our [demos](demos/), you may have seen
these components work in concert! This document explains a little more of what
goes on behind the hood!

Expand Down Expand Up @@ -91,7 +91,7 @@ of the GraphQL server, but logically part of ingestion).

#### CollectSub

The collect subcriber service provides a way to express a want for a datasource
The collect subscriber service provides a way to express a want for a datasource
to be used, or indication that more data about a software identifier is desired.
For example, in parsing an SBOM, if it sees the use of a package with a PURL,
the ingestor creates and entry to the CollectSub service to indicate more
Expand Down Expand Up @@ -161,7 +161,7 @@ automatically.
Once it is up, you should be able to verify that its running

```bash
docker compose ls --filter "name=guac"
docker-compose ls --filter "name=guac"
```

with expected output:
Expand All @@ -174,7 +174,7 @@ guac running(7) /Users/lumb/go/src/github.com/guacsec/gu
### Note

If you are running into trouble getting the server started up, you can try
runnning `docker-compose down` first. Because docker compose caches the
running `docker-compose down` first. Because docker compose caches the
containers used, the unclean state can cause issues.

## Start Ingesting Data
Expand Down

0 comments on commit 8e94827

Please sign in to comment.