Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Create markdown book #24

Merged
merged 2 commits into from
May 19, 2022
Merged

Create markdown book #24

merged 2 commits into from
May 19, 2022

Conversation

ra0x3
Copy link
Contributor

@ra0x3 ra0x3 commented May 15, 2022 •
edited
Loading

Description

  • This PR creates an initial Fuel Indexer markdown book with CI
  • This book will be updated piece-by-piece as the fuel-indexer service is tested/documented/etc
  • The initial book should include a "Getting started"

Testing steps

  • CI should pass
  • Feel free to pull down the PR and build/test the book locally

@ra0x3 ra0x3 added the documentation Improvements or additions to documentation label May 15, 2022
@ra0x3 ra0x3 added this to the Documentation milestone May 15, 2022
@ra0x3 ra0x3 self-assigned this May 15, 2022
@ra0x3 ra0x3 linked an issue May 15, 2022 that may be closed by this pull request
Create a fuel-indexer markdown book #22
Closed
@mitchmindtree mitchmindtree requested review from tjsharp1 and removed request for tjsharp1 May 16, 2022 08:33
@mitchmindtree
Copy link
Contributor

mitchmindtree commented May 16, 2022 •
edited
Loading

Woohoo! Looking forward to seeing this get fleshed out.

I added TJ to review then realised this might still be WIP? If this is still WIP, remember to use the "Draft" feature. If it's ready for review, don't forget to request some reviewers :)

@ra0x3 ra0x3 marked this pull request as draft May 16, 2022 17:27
@ra0x3
Copy link
Contributor Author

ra0x3 commented May 16, 2022

@mitchmindtree

@ra0x3 ra0x3 force-pushed the rashad/22-create-markdown-book branch from 04c0466 to 0eb6c17 Compare May 16, 2022 18:05
@ra0x3 ra0x3 marked this pull request as ready for review May 16, 2022 22:46
@ra0x3 ra0x3 mentioned this pull request May 17, 2022
Closed
mitchmindtree
mitchmindtree reviewed May 17, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
docs/src/README.md Outdated Show resolved Hide resolved
@ra0x3 ra0x3 force-pushed the rashad/22-create-markdown-book branch from bbeb70f to 59d9b8e Compare May 17, 2022 16:56
@ra0x3 ra0x3 requested a review from mitchmindtree May 17, 2022 17:14
adlerjohn
adlerjohn reviewed May 17, 2022
View reviewed changes
docs/book.toml Outdated Show resolved Hide resolved
docs/src/getting-started/basics.md Outdated Show resolved Hide resolved
@ra0x3 ra0x3 force-pushed the rashad/22-create-markdown-book branch from c6eeec5 to 74e91e3 Compare May 17, 2022 18:21
adlerjohn
adlerjohn reviewed May 17, 2022
View reviewed changes
README.md Outdated Show resolved Hide resolved
docs/src/README.md Outdated Show resolved Hide resolved
docs/src/README.md Outdated Show resolved Hide resolved
docs/src/README.md Outdated Show resolved Hide resolved
adlerjohn
adlerjohn reviewed May 17, 2022
View reviewed changes
docs/src/getting-started/setup.md
Comment on lines +61 to +55
export OPENSSL_LIB_DIR="/usr/lib/openssl-1.0";
export OPENSSL_INCLUDE_DIR="/usr/include/openssl-1.0"
Copy link
Contributor

Choose a reason for hiding this comment

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

These aren't permanent. What's the purpose of setting these variables?

Suggested change
export OPENSSL_LIB_DIR="/usr/lib/openssl-1.0";
export OPENSSL_INCLUDE_DIR="/usr/include/openssl-1.0"
export OPENSSL_LIB_DIR="/usr/lib/openssl-1.0"
export OPENSSL_INCLUDE_DIR="/usr/include/openssl-1.0"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@adlerjohn These are just copied over from the ReadMe. I'm assuming @tjsharp1 had a good reason to document them

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmmm. Well we can leave them in for now if there's no resolution and remove them later. If this PR is merged as-is then please file an issue to track investigating these lines.

@ra0x3 ra0x3 force-pushed the rashad/22-create-markdown-book branch from 74e91e3 to e13ae57 Compare May 17, 2022 19:47
adlerjohn
adlerjohn reviewed May 17, 2022
View reviewed changes
Copy link
Contributor

@adlerjohn adlerjohn left a comment

Choose a reason for hiding this comment

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

Generally looks fine to me, will defer to @tjsharp1 and @mitchmindtree

mitchmindtree
mitchmindtree approved these changes May 18, 2022
View reviewed changes
Copy link
Contributor

@mitchmindtree mitchmindtree left a comment

Choose a reason for hiding this comment

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

LGTM!

If @tjsharp1 could also review this that would be great, but he's conferencing atm so leaving a tick as to not block landing this.

@ra0x3 ra0x3 merged commit 8dfab7f into master May 19, 2022
@ra0x3 ra0x3 deleted the rashad/22-create-markdown-book branch May 19, 2022 13:30
@ra0x3 ra0x3 mentioned this pull request Jun 6, 2022
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adlerjohn adlerjohn adlerjohn left review comments

@mitchmindtree mitchmindtree mitchmindtree approved these changes

@tjsharp1 tjsharp1 tjsharp1 approved these changes

Assignees

@ra0x3 ra0x3

Labels
documentation Improvements or additions to documentation
Projects
Fuel Network
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create a fuel-indexer markdown book
4 participants
@ra0x3 @mitchmindtree @adlerjohn @tjsharp1