Skip to content

Updating the documents with a few fixes. #1

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Mar 13, 2025
Merged

Updating the documents with a few fixes. #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c929669
Updaing the
aasawariMongoDB Feb 7, 2025
141a7c1
Adding fixes after code review
aasawariMongoDB Feb 15, 2025
ae02dc5
Documenting to add pkgconf before installing mongodb driver
aasawariMongoDB Feb 25, 2025
3c11f17
Modifyng the sentence after review
aasawariMongoDB Mar 11, 2025
f3f1f2e
Adding command to install openssl before pkgconf
aasawariMongoDB Mar 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/30-quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ composer create-project symfony/skeleton rentals

<Tabs>
<TabItem value="Mac">

With MacOS, ensure that OpenSSL is installed on your system. You can install it using Homebrew with the following command:

```shell
brew install openssl
```

Next, install pkgconf using Homebrew, as mentioned in the [Homebrew documentation](https://formulae.brew.sh/formula/pkgconf):

```shell
brew install pkgconf
Copy link

@jmikola jmikola Feb 25, 2025

Choose a reason for hiding this comment

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

Can we trust that openssl@3 will already be installed in Homebrew? Just asking as that's what we're expecting to find with pkg-config.

Copy link

@alcaeus alcaeus Feb 26, 2025

Choose a reason for hiding this comment

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

Homebrew includes an alias for openssl that points to openssl@3, so unless people explicitly install openssl@1 they'll get the expected version.

I am a bit curious about "expecting to find" here - we're looking for openssl >= 1.0.1 in CheckSSL.m4, so I'm not sure why we're expecting to find openssl 3.

Copy link

@jmikola jmikola Feb 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Apologies. I just saw my local package and forgot that CheckSSL.m4 only requires 1.0.1+ when I wrote that.

It was less about suggesting version 3+ and more about whether we should tell users they need openssl itself installed (to avoid falling back to Secure Transport). I don't recall installing it manually in Homebrew. I think it was just pulled in by some other packages.

Copy link

@alcaeus alcaeus Feb 27, 2025

Choose a reason for hiding this comment

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

Yes, we may consider suggesting people install openssl as well - even though there is a high likelihood that it will have been installed as a dependency for other development tools.

Copy link
Contributor Author

@aasawariMongoDB aasawariMongoDB Mar 13, 2025

Choose a reason for hiding this comment

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

Added.

```

Once installed, you can start with mongodb driver installation for PHP

```shell
cd rentals
pecl install mongodb
Expand Down Expand Up @@ -66,7 +81,7 @@ doctrine_mongodb:
auto_generate_hydrator_classes: true
connections:
default:
server: '%env(resolve:MONGODB_URL)%&appName=devrel.content.php'
server: '%env(resolve:MONGODB_URL)%'
options: {}
default_database: '%env(resolve:MONGODB_DB)%'
document_managers:
Expand Down
26 changes: 13 additions & 13 deletions docs/40-structure-site/1-app-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,29 +26,29 @@ Collections:
},
"name": "Fahey, Leannon and Gleichner",
"location": "Elisabethland",
"night_cost": 415,
"nightCost": 415,
"availability": [
{
"start_date": {
"startDate": {
"$date": "2024-01-01T00:00:00.000Z"
},
"end_date": {
"endDate": {
"$date": "2024-04-16T00:00:00.000Z"
}
},
{
"start_date": {
"startDate": {
"$date": "2024-04-21T00:00:00.000Z"
},
"end_date": {
"endDate": {
"$date": "2024-04-25T00:00:00.000Z"
}
},
{
"start_date": {
"startDate": {
"$date": "2024-05-01T00:00:00.000Z"
},
"end_date": {
"endDate": {
"$date": "2025-01-01T00:00:00.000Z"
}
}
Expand All @@ -63,14 +63,14 @@ The document above represents a rental listing. It has a name, location, night_c
"_id": {
"$oid": "65dca21600a610ba8536b343"
},
"rental_id": "65dca21600a610ba8536b343",
"rental_name": "Fahey, Leannon and Gleichner",
"night_cost": 415,
"total_cost": 1245,
"start_date": {
"rental": {"$ref":"rentals","$id":{"$oid":"65dca21600a610ba8536b343"}},
"rentalName": "Fahey, Leannon and Gleichner",
"nightCost": 415,
"totalCost": 1245,
"startDate": {
"$date": "2024-04-17T00:00:00.000Z"
},
"end_date": {
"endDate": {
"$date": "2024-04-20T00:00:00.000Z"
}
}
Expand Down
6 changes: 3 additions & 3 deletions docs/40-structure-site/1-initial-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,11 +396,11 @@ for (let i = 0; i < 100; i++) {
rentals.push({
name: falso.randCompanyName(),
location: falso.randCity(),
night_cost: falso.randNumber({ min: 50, max: 500 }), // Random cost between 50 and 500
nightCost: falso.randNumber({ min: 50, max: 500 }), // Random cost between 50 and 500
availability: [
{
start_date: new Date('2024-01-01'),
end_date: new Date('2026-01-01')
startDate: new Date('2024-01-01'),
endDate: new Date('2026-01-01')
}
]
});
Expand Down