Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

docs: update non-book docs #1161

Merged
merged 6 commits into from
Jul 31, 2023
Merged

docs: update non-book docs #1161

merged 6 commits into from
Jul 31, 2023

Conversation

ra0x3
Copy link
Contributor

@ra0x3 ra0x3 commented Jul 31, 2023

  • Please add proper labels
  • If there is an issue associated with this PR, please link the issue (right-hand sidebar)
  • If there is not an issue associated with this PR, add this PR to the "Fuel Indexer" project (right-hand sidebar)

Description

Please include a short derscription of what this PR does.

Testing steps

Please provide the exact testing steps for the reviewer(s) if this PR requires testing.

Changelog

Please add a neat Changelog info here according to our Contributor's Guide.

@ra0x3 ra0x3 added documentation Improvements or additions to documentation chore labels Jul 31, 2023
@ra0x3 ra0x3 self-assigned this Jul 31, 2023
@ra0x3 ra0x3 requested a review from deekerno as a code owner July 31, 2023 15:27
@ra0x3 ra0x3 marked this pull request as draft July 31, 2023 15:27
@ra0x3 ra0x3 linked an issue Jul 31, 2023 that may be closed by this pull request
4 tasks
@ra0x3
Copy link
Contributor Author

ra0x3 commented Jul 31, 2023

@deekerno @lostman Could you your eyes here. Trying to cleanup the README as a lot of the info in the #Users section was head scratching (though I'm sure made sense at the time)

@deekerno
Copy link
Contributor

@ra0x3: Nice. Personally, I think that it would be beneficial to remove any third-level and deeper indents in the table of contents.

- [For Users](#for-users)
  - [Dependencies](#dependencies)
    - [`fuelup`](#fuelup)
    - [`WebAssembly`](#webassembly)
  - [`forc-index` Plugin](#forc-index-plugin)
  - [WebAssembly (WASM) modules](#webassembly-wasm-modules)
- [For Contributors](#for-contributors)
  - [Dev Dependencies](#dev-dependencies)
    - [`docker`](#docker)
    - [Database](#database)
      - [PostgreSQL](#postgresql)
    - [SQLx](#sqlx)
  - [Building from Source](#building-from-source)
    - [Clone repository](#clone-repository)
    - [Run migrations](#run-migrations)
      - [PostgreSQL migrations](#postgresql-migrations)
    - [Start the service](#start-the-service)
  - [Testing](#testing)
    - [Default tests](#default-tests)
    - [End-to-end tests](#end-to-end-tests)
    - [`trybuild` tests](#trybuild-tests)
  - [Contributing](#contributing)
- [Read the book](#read-the-book)

becomes

- [For Users](#for-users)
  - [Dependencies](#dependencies)
  - [`forc-index` Plugin](#forc-index-plugin)
  - [WebAssembly (WASM) modules](#webassembly-wasm-modules)
- [For Contributors](#for-contributors)
  - [Dev Dependencies](#dev-dependencies)
  - [Building from Source](#building-from-source)
  - [Testing](#testing)
  - [Contributing](#contributing)
- [Read the book](#read-the-book)

Less scary overall, you know?


```bash
forc index start \
--embedded-database
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--embedded-database is simply just not reliable enough to include this in the Quickstart.

@ra0x3 ra0x3 marked this pull request as ready for review July 31, 2023 18:23
@ra0x3 ra0x3 requested a review from lostman July 31, 2023 18:23
@ra0x3 ra0x3 merged commit ecc19eb into develop Jul 31, 2023
45 checks passed
@ra0x3 ra0x3 deleted the rashad/1159-update-non-book-docs branch July 31, 2023 19:01
ra0x3 added a commit that referenced this pull request Aug 2, 2023
* fix: add sql endpoint auth + make `run_query` fail gracefully (#1136)

* fix: add sql endpoint auth

* retrigger ci?

---------

Co-authored-by: Rashad Alston <[email protected]>

* chore: switch to manual sqlx query logging (#1138)

* chore: switch to manual sqlx query logging

* fix test

* uat

* add rustdoc

---------

Co-authored-by: Rashad Alston <[email protected]>

* fix: update readme (#1141)

* enhancement: make `NODE_BLOCK_PAGE_SIZE` configurable (#1147)

* Replace blocking `reqwest` usage with async (#1148)

* Revert "Replace blocking `reqwest` usage with async" (#1151)

Revert "Replace blocking `reqwest` usage with async (#1148)"

This reverts commit 19dbf2a.

* docs: adjust docs to include `--block-page-size` on start commands (#1153)

Adjust docs for start commands

* Replace blocking `reqwest` usage with async (#1152)

* fix: don't skip blocks on constraint error (#1154)

* fix: don't skip blocks on constraint error

* fix test

---------

Co-authored-by: Rashad Alston <[email protected]>

* Adding resources to helm chart (#1160)

* Update --replace-indexer and add --remove-data (#1146)

* remove debug info message (#1163)

* docs: update non-book docs (#1161)

* docs: update non-book docs

* updates

* markdownrc

* update contributing.md

* update release schedule

* update example readmes

---------

Co-authored-by: Rashad Alston <[email protected]>

* Fix incorrect schema digest (#1165)

* forc index deploy: register correct schema

* bugfix: we are removing the schema and registering it again

* log registered asset version

* add docs CI (#1158)

* enhancement: implement many-to-many relationships (#1140)

* enhancement: impl m2m inserts

* update implementation

* get the explorer working

* update native exec

* cleanup + updates

* get union types working

* use multiple queries

* rebase origin/develop

* fix test

---------

Co-authored-by: Rashad Alston <[email protected]>

* chore: improve UX of `forc index` plugin commands (#1142)

* Remove forc index new

* Allow for optional namespace in forc index init

* Remove profile and target flags from forc index build; change release bool to debug

* Remove service check from forc index check

* Move service check into forc index status

* Cleanup

* Remove short arg collision from forc index postgres

* Fix CI

* Replace forc_index_init with forc_index_new

* Adjust tests and documentation

* Address feedback; clean up some other things

* Address everything for real this time

* ci: streamline develop <> master merges (#1166)

* ci: use new formatter + fix master<>develop merging  (#1169)

fix: new ci formatting + fix master<>develop merge

Co-authored-by: Rashad Alston <[email protected]>

* v0.19.0 (#1172)

Co-authored-by: Rashad Alston <[email protected]>

---------

Co-authored-by: Rashad Alston <[email protected]>
Co-authored-by: Alexander <[email protected]>
Co-authored-by: JC <[email protected]>
Co-authored-by: roy_fuel <[email protected]>
Co-authored-by: Maciej Woś <[email protected]>
Co-authored-by: Sarah Schwartz <[email protected]>
@ra0x3 ra0x3 mentioned this pull request Aug 2, 2023
7 tasks
ra0x3 added a commit that referenced this pull request Aug 2, 2023
master <> develop (#1177)

* fix: add sql endpoint auth + make `run_query` fail gracefully (#1136)

* fix: add sql endpoint auth

* retrigger ci?

---------



* chore: switch to manual sqlx query logging (#1138)

* chore: switch to manual sqlx query logging

* fix test

* uat

* add rustdoc

---------



* fix: update readme (#1141)

* enhancement: make `NODE_BLOCK_PAGE_SIZE` configurable (#1147)

* Replace blocking `reqwest` usage with async (#1148)

* Revert "Replace blocking `reqwest` usage with async" (#1151)

Revert "Replace blocking `reqwest` usage with async (#1148)"

This reverts commit 19dbf2a.

* docs: adjust docs to include `--block-page-size` on start commands (#1153)

Adjust docs for start commands

* Replace blocking `reqwest` usage with async (#1152)

* fix: don't skip blocks on constraint error (#1154)

* fix: don't skip blocks on constraint error

* fix test

---------



* Adding resources to helm chart (#1160)

* Update --replace-indexer and add --remove-data (#1146)

* remove debug info message (#1163)

* docs: update non-book docs (#1161)

* docs: update non-book docs

* updates

* markdownrc

* update contributing.md

* update release schedule

* update example readmes

---------



* Fix incorrect schema digest (#1165)

* forc index deploy: register correct schema

* bugfix: we are removing the schema and registering it again

* log registered asset version

* add docs CI (#1158)

* enhancement: implement many-to-many relationships (#1140)

* enhancement: impl m2m inserts

* update implementation

* get the explorer working

* update native exec

* cleanup + updates

* get union types working

* use multiple queries

* rebase origin/develop

* fix test

---------



* chore: improve UX of `forc index` plugin commands (#1142)

* Remove forc index new

* Allow for optional namespace in forc index init

* Remove profile and target flags from forc index build; change release bool to debug

* Remove service check from forc index check

* Move service check into forc index status

* Cleanup

* Remove short arg collision from forc index postgres

* Fix CI

* Replace forc_index_init with forc_index_new

* Adjust tests and documentation

* Address feedback; clean up some other things

* Address everything for real this time

* ci: streamline develop <> master merges (#1166)

* ci: use new formatter + fix master<>develop merging  (#1169)

fix: new ci formatting + fix master<>develop merge



* v0.19.0 (#1172)



---------

Co-authored-by: Rashad Alston <[email protected]>
Co-authored-by: Alexander <[email protected]>
Co-authored-by: JC <[email protected]>
Co-authored-by: roy_fuel <[email protected]>
Co-authored-by: Maciej Woś <[email protected]>
Co-authored-by: Sarah Schwartz <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update non-book documentation
2 participants