Add FAQ page for doc/On-Premises-FPGA-Getting-Started #1612
Conversation
william-lyh
added
the
changelog:added
There was a problem hiding this comment.
You need to point to this file in the index.rst (otherwise it won't get rendered).
There was a problem hiding this comment.
The file should also not be named "Template" since it's not being templatized. Or IMO, this might be better to be added to each FPGA section as a template (i.e. each FPGA part of the docs has it's own FAQ).
|
|
||
| To streamline the set-up process, we provide fix suggestions to the following errors that might appear during the process for reference. | ||
|
|
||
| **SSH Setup** |
There was a problem hiding this comment.
This should be a subtitle not bold.
|
|
||
| Please also note that ssh-agent might need to be set-up each time a new terminal is started. | ||
|
|
||
| **Build Bitstream** |
| To streamline the set-up process, we provide fix suggestions to the following errors that might appear during the process for reference. | ||
|
|
||
| **SSH Setup** | ||
| ``build bitstream`` process stuck at :: |
There was a problem hiding this comment.
This isn't unique to just the buildbitstream... this happens on a lot of FireSim steps. I would generalize a bit more here.
| [localhost] local: pwd | ||
| [localhost] run: ... |
There was a problem hiding this comment.
Use the code-block directive (search in other parts of the docs)
| [localhost] run: ... | ||
|
|
||
|
|
||
| The manager machine should be able to use ssh protocal to connect to build_farm and run_farm machines without providing password or passphrase duirng the connection process. |
There was a problem hiding this comment.
Instead, I would say that there is no passwordless access to the machine in question (i.e. localhost). And I would add a link to SSH setup docs that already exist.
| Verify this by using ``ssh`` command from the manager machine. If a password or passphrase prompt appears, ssh-agent can be used to store and automatically provide login credentials. :: | ||
|
|
||
| ssh-agent -s > AGENT_VARS | ||
| source AGENT_VARS | ||
| ssh-add ~/.ssh/firesim.pem |
There was a problem hiding this comment.
I would try to dedup. this with the other parts of the documentation (for easier future maintenance).
| source AGENT_VARS | ||
| ssh-add ~/.ssh/firesim.pem | ||
|
|
||
| Please also note that ssh-agent might need to be set-up each time a new terminal is started. |
There was a problem hiding this comment.
Nit: Anything that is referenced in the code (or must be typed in the CLI) should be put in backticks (`)
|
|
||
| This error is probably due to shell login scripts writing to standard out. | ||
|
|
||
| Edit ``~/.bashrc`` and/or other login scripts to make sure standard out writing commands such as ``echo`` are either commented out or only executed when the shell is in interactive mode(directly receving commands typed by a user). |
There was a problem hiding this comment.
| Edit ``~/.bashrc`` and/or other login scripts to make sure standard out writing commands such as ``echo`` are either commented out or only executed when the shell is in interactive mode(directly receving commands typed by a user). | |
| Edit ``~/.bashrc`` and/or other login scripts to make sure that commands that write to stdout (such as ``echo``) are either commented out or only executed when the shell is in interactive mode (directly receiving commands typed by a user). |
Related PRs / Issues
None
UI / API Impact
No impact
Verilog / AGFI Compatibility
No impact
Contributor Checklist
changelog:<topic>label?ci:fpga-deploylabel?Please Backportlabel?Reviewer Checklist (only modified by reviewer)
Note: to run CI on PRs from forks, comment
@Mergifyio copy mainand manage the change from the new PR.changelog:<topic>label?