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 Bandada docs inside apps folder #427

Merged
merged 10 commits into from
Mar 8, 2024
Merged

Add Bandada docs inside apps folder #427

merged 10 commits into from
Mar 8, 2024

Conversation

vplasencia
Copy link
Member

Description

This PR adds the Bandada documentation inside the apps folder.

Related Issue

#426

Does this introduce a breaking change?

  • Yes
  • No

@vplasencia vplasencia requested a review from 0xjei March 6, 2024 23:03
@vplasencia vplasencia changed the title Feat/docs Add Bandada docs inside apps folder Mar 6, 2024
Copy link
Contributor

@0xjei 0xjei left a comment

Choose a reason for hiding this comment

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

Great work! I noticed that running yarn start results in an error for the Nest application due to the 3000 port being already occupied by docusaurus. Thank you for your work!

[Nest] 254486  - 03/07/2024, 11:04:28 PM     LOG [NestApplication] Nest application successfully started +3ms
[Nest] 254486  - 03/07/2024, 11:04:28 PM   ERROR [NestApplication] Error: listen EADDRINUSE: address already in use :::3000 +1ms
node:internal/errors:563
    ErrorCaptureStackTrace(err);
    ^

Error: listen EADDRINUSE: address already in use :::3000
    at Server.setupListenHandle [as _listen2] (node:net:1872:16)
    at listenInCluster (node:net:1920:12)
    at Server.listen (node:net:2008:7)
    at ExpressAdapter.listen (/home/giacomo/Documents/EF/Code/bandada/node_modules/@nestjs/platform-express/adapters/express-adapter.js:88:32)
    at /home/giacomo/Documents/EF/Code/bandada/node_modules/@nestjs/core/nest-application.js:180:30
    at new Promise (<anonymous>)
    at NestApplication.listen (/home/giacomo/Documents/EF/Code/bandada/node_modules/@nestjs/core/nest-application.js:169:16)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async bootstrap (/home/giacomo/Documents/EF/Code/bandada/apps/api/dist/main.js:109:5) {
  code: 'EADDRINUSE',
  errno: -98,
  syscall: 'listen',
  address: '::',
  port: 3000
}

Node.js v20.11.0
✔ Client: Compiled successfully in 4.21s
client (webpack 5.90.3) compiled successfully

favicon: "img/favicon.ico",

// Set the production url of your site here
url: "https://your-docusaurus-site.example.com",
Copy link
Contributor

Choose a reason for hiding this comment

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

We should change also these default values url, organizationName, projectName and editUrl. Otherwise, if aren't needed, we can get rid of them for now.

Copy link
Member Author

Choose a reason for hiding this comment

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

I will update these values, thanks.

Copy link
Member Author

Choose a reason for hiding this comment

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

I updated everything with the new Bandada org because we will move the repo this week.

@@ -0,0 +1,47 @@
{
"name": "bandada-docs",
"version": "0.0.0",
Copy link
Contributor

Choose a reason for hiding this comment

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

At least 0.0.1?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks. I will remove that version property because it's not necessary.

@vplasencia
Copy link
Member Author

Hey @0xjei, thanks for pointing it out. I will add --exclude bandada-docs in the start command to exclude the docs when running yarn start.

@0xjei
Copy link
Contributor

0xjei commented Mar 7, 2024

Hey @0xjei, thanks for pointing it out. I will add --exclude bandada-docs in the start command to exclude the docs when running yarn start.

Sweet, thank you @vplasencia :)

@vplasencia vplasencia requested a review from 0xjei March 7, 2024 22:43
@vplasencia vplasencia merged commit 49b63bd into dev Mar 8, 2024
2 checks passed
@vplasencia vplasencia deleted the feat/docs branch March 11, 2024 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants