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.

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

Add backscope docs to frontscope docsite #42

Open
liammulh opened this issue Jun 7, 2022 · 4 comments
Open

Add backscope docs to frontscope docsite #42

liammulh opened this issue Jun 7, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@liammulh
Copy link
Member

liammulh commented Jun 7, 2022

As of this writing, there's a text file in this repo for setting up the database. It's outdated. We need an up-to-date version in the documentation system/site we eventually end up using.

@liammulh liammulh self-assigned this Jun 7, 2022
@liammulh liammulh added the documentation Improvements or additions to documentation label Jun 7, 2022
@gwhitney gwhitney changed the title Instructions for setting up database should be integrated into documentation system/site Instructions for setting up database should be added (and linke from frontscope docsite) Jul 11, 2022
@gwhitney gwhitney changed the title Instructions for setting up database should be added (and linke from frontscope docsite) Instructions for setting up database should be added (and linked from frontscope docsite) Jul 11, 2022
@liammulh
Copy link
Member Author

As @gwhitney noted in another issue, setting up the database is highly OS-dependent, and it's even dependent on your Linux distro. So I think having detailed instructions for setting up the database is unrealistic. The instructions in the current README have worked fine for me.

That being said, I'd still like to have the backscope docs on the website. Perhaps we could use this issue for that? I'm going to rename the issue.

@liammulh liammulh changed the title Instructions for setting up database should be added (and linked from frontscope docsite) Add backscope docs to frontscope docsite Oct 24, 2022
@liammulh
Copy link
Member Author

As for how we will get the backscope docs onto the frontscope docsite...

Do we configure frontscope's mkdocs.yml to expect a parallel checkout of backscope? What happens if there isn't a parallel checkout of backscope?

@liammulh
Copy link
Member Author

Perhaps we could do something fancy with symlinks?

@liammulh
Copy link
Member Author

I'm not working on this right now. Unassigning myself.

@liammulh liammulh removed their assignment Jan 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

1 participant