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

Fix doc build instructions #223

Closed
wants to merge 1 commit into from
Closed

Fix doc build instructions #223

wants to merge 1 commit into from

Conversation

johhnry
Copy link

@johhnry johhnry commented Aug 27, 2024

Changelog Description

I opened this issue #222 but realized that the build instructions were outdated. Now package.json is in the website folder so we need to cd into it and install the dependencies.

@johhnry johhnry changed the title fix doc build instructions Fix doc build instructions Aug 27, 2024
@MustafaJafar MustafaJafar added community type: enhancement New feature or request labels Sep 5, 2024
Copy link
Contributor

@MustafaJafar MustafaJafar left a comment

Choose a reason for hiding this comment

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

hey, thank you for your interest.
I think we should split the build instructions..
let me create another PR and then we'd be able to continue the conversation there.
Edit: Here it's #235

@MustafaJafar
Copy link
Contributor

MustafaJafar commented Sep 7, 2024

Closing this PR in favor of #235.
Let move the discussion to the other PR and confirm if the build instructions are easy to follow and work. also confirm if it fixes #222, it's already closed.

@BigRoy
Copy link
Contributor

BigRoy commented Oct 8, 2024

@MustafaJafar with #235 now not merged - is this issue #222 actually still an issue and thus this PR relevant?

@MustafaJafar
Copy link
Contributor

MustafaJafar commented Oct 8, 2024

@BigRoy
Tbh, after the discussion on #235
I think we may only do one change, which is cd the website directory before running the docusaurus command.
so, it should be like this

- Install Node.js https://nodejs.org/en/download
- `npm install -g yarn`
- `cd {ayon-doc-repo}/website`
- `yarn add docusaurus --dev`
- `yarn start`

and I think it's a grey area whether or not to add any explanation. I know that the main audience are the developers. But in CGI world we may have curious people who may know nothing very little about the topic but they want to try it and willing to contribute. this was the main motivation for #235.
anyways, I can't come up with ideas right now. maybe I'll try again tomorrow.

@BigRoy
Copy link
Contributor

BigRoy commented Oct 8, 2024

I think @johhnry 's point is that the website/ folder 'lock' already includes docusaurus as dependency - hence going into that folder and doing yarn install will do the same (and include other dependencies if needed).

I'm not familiar with NodeJS - so maybe @Innders needs to chime in as to what's sensible in this area?

@Innders
Copy link
Member

Innders commented Oct 9, 2024

I think #283 should solve this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community type: enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants