chore: docs restructure#2322
Conversation
|
I will start reviewing this, thanks Cat! cc @iAmMichaelConnor so you can flag anything that might be concerning |
…ztec-packages into docs-restructure
| ``` | ||
|
|
||
| NOTE: If `SANDBOX_VERSION` is not defined, the script will pull the latest release of the sandbox. | ||
|
|
There was a problem hiding this comment.
There's another 'getting started' guide somewhere that mentions port conflicts. We should mention that here too. If they get errors about port conflicts, when running this curl command, they should check whether those ports are already in use (insert the commands which would enable someone to check conflicting ports for 8080 and 8545).
To specify different ports, they'd need to edit the docker-compose file which got saved in .aztec/docker-compose.yml: nano .aztec/docker-compose.yml then change PORTS: 8080:8080 to PORTS: <other port>:8080 (and same for 8545 if there's a conflict at that port too). (I might have got the docker compose syntax wrong - I'm basing this off memory).
(As an alternative to modifying the docker-compose.yml, a user might be able to specify an env file (from memory), with overwrites to the ports)
Then, when doing CLI commands, they'd need to specify --rpc-url=<other port> with each cli command.
There was a problem hiding this comment.
Also, if they re-run the curl command, it will overwrite their custom changes to the port number in the docker-compose.yml file. (So the env file approach might be better)
There was a problem hiding this comment.
Can we open a new issue to change the port from 8080 to 4273 (because it looks like AZTE(c)) and because 8080 is used by everything (especially the mainframe!)
There was a problem hiding this comment.
I am testing out editing the docker-comose.yml file. It looks like its <other port>:8080, but when it starts up it still prints sandbox Aztec Sandbox JSON-RPC Server listening on port 8080 in the terminal even when it's been changed.
I'll update the quickstart page with this note.
There was a problem hiding this comment.
created an issue here: #2381
I likely wont have time to add this to the docs in the next couple days, but can do later.
There was a problem hiding this comment.
but when it starts up it still prints sandbox Aztec Sandbox JSON-RPC Server listening on port 8080
Ah, yeah that'll be because from the sandbox's perspective, it's still communicating via port 8080 (regardless of which port you forward from your local machine)
add discord link, remove unused files/sections, update links
critesjosh
left a comment
There was a problem hiding this comment.
thanks for starting this @catmcgee! I am going to merge these changes and we can make additional edits if necessary.
|
@critesjosh I'm late to the party but I wonder if this is being deployed to netlify? Would be great to have a preview for docs changes |
🤖 I have created a release *beep* *boop* --- <details><summary>aztec-packages: 0.7.8</summary> ## [0.7.8](aztec-packages-v0.7.7...aztec-packages-v0.7.8) (2023-09-19) ### Features * `NodeInfo` cleanup ([#2370](#2370)) ([89fe978](89fe978)) * Allow custom ports in sandbox ([#2393](#2393)) ([41ef378](41ef378)) * Allow tracing build system with [debug ci] ([#2389](#2389)) ([ce311a9](ce311a9)) * **docs:** Show current noir version for aztec in docs ([#2379](#2379)) ([5c7b2ab](5c7b2ab)) ### Bug Fixes * Build script exiting on failed grep ([#2384](#2384)) ([e70a781](e70a781)) * Bump e2e_sandbox_example.test.ts timeout ([#2391](#2391)) ([9a1bb62](9a1bb62)) * Compile script for the unboxed project ([#2380](#2380)) ([2801da2](2801da2)) * Force_deploy_build error ([#2375](#2375)) ([4d1cbf9](4d1cbf9)) * Update aztec sandbox getting started markdown ([#2374](#2374)) ([a3c6bcf](a3c6bcf)) ### Miscellaneous * Adds on-brand design to private token project ([#2355](#2355)) ([072e313](072e313)) * Docs restructure ([#2322](#2322)) ([1368b55](1368b55)) ### Documentation * Updated noirup command ([#2339](#2339)) ([5308c21](5308c21)) </details> <details><summary>barretenberg.js: 0.7.8</summary> ## [0.7.8](barretenberg.js-v0.7.7...barretenberg.js-v0.7.8) (2023-09-19) ### Miscellaneous * **barretenberg.js:** Synchronize aztec-packages versions </details> <details><summary>barretenberg: 0.7.8</summary> ## [0.7.8](barretenberg-v0.7.7...barretenberg-v0.7.8) (2023-09-19) ### Features * Allow tracing build system with [debug ci] ([#2389](#2389)) ([ce311a9](ce311a9)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
|
Yes it is. The problem is that previews will be created for every PR, which is irrelevant for most PRs and its noisy. That's why I turned it off. You can preview locally. |
Checklist:
Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.