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 some typos in markdown files #25274

Merged
merged 2 commits into from
Feb 21, 2024
Merged

Conversation

qmonmert
Copy link
Contributor


Please make sure the below checklist is followed for Pull Requests.

When you are still working on the PR, consider converting it to Draft (below reviewers) and adding skip-ci label, you can still see CI build result at your branch.

@qmonmert qmonmert requested a review from DanielFran February 20, 2024 21:20
@@ -73,7 +73,7 @@ export default class Generator {
}
```

Using at a child generator:
Using a child generator:
Copy link
Member

Choose a reason for hiding this comment

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

in?

Copy link
Member

@mshima mshima Feb 20, 2024

Choose a reason for hiding this comment

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

Using needles api inside a child generator: ?

@@ -147,9 +147,9 @@ The README.md file provides a glimpse of this first iteration, but after a lot o

- **Q: This definitely is cool but is this really necessary for a JHipster application.**
- **A**: If you are running in Kubernetes, the JHipster K8s Operator will provide you extra functionality and it will allow Kubernetes to understand JHipster specific concerns.
- **Q: Are we rebuilding any features provided by tools like Istio(coz many of the proposed features looks very similar to what it does)**
- **Q: Are we rebuilding any features provided by tools like Istio(coz many of the proposed features look very similar to what it does)**
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- **Q: Are we rebuilding any features provided by tools like Istio(coz many of the proposed features look very similar to what it does)**
- **Q: Are we rebuilding any features provided by tools like Istio (because many of the proposed features look very similar to what it does)?**

@@ -63,7 +63,7 @@ The **JHipster Control Center** is a standard web application that connects to o

### Description of features

Once logged into the **JHipster Control Center**, the user will be able to view his administrator UI which present operational data coming from his JHipster applications. Typical data available from there will include:
Once logged into the **JHipster Control Center**, the user will be able to view his administrator UI which presents operational data coming from his JHipster applications. Typical data available from there will include:
Copy link
Contributor

@mraible mraible Feb 20, 2024

Choose a reason for hiding this comment

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

Suggested change
Once logged into the **JHipster Control Center**, the user will be able to view his administrator UI which presents operational data coming from his JHipster applications. Typical data available from there will include:
Once logged into the **JHipster Control Center**, the user will be able to view their administrator UI which presents operational data coming from their JHipster applications. Typical data available will include:

@@ -74,7 +74,7 @@ The goal of the **JHipster Control Center** is to be used in combination with an

### Usage in development

In every JHipster app, docker-compose files are present in the `src/main/docker` folder to launch associated services such as databases, message brokers and registries using docker. Among them, a **jhipster-control-center.yml** will let the users starts the **JHipster control-center** which will then be available at [http://localhost:1337](http://localhost:1337). By default the docker-compose file will be generated in such a way that the Control Center will be able to connect to the locally running JHipster application out of the box. Another possible way to run the **JHipster Control Center** in development would be to develop a simple CLI that allows to start the **JHipster Control Center** server quickly. Such a CLI tool could be embedded into the JHipster package distributed on NPM.
In every JHipster app, docker-compose files are present in the `src/main/docker` folder to launch associated services such as databases, message brokers and registries using docker. Among them, a **jhipster-control-center.yml** will let the users start the **JHipster control-center** which will then be available at [http://localhost:1337](http://localhost:1337). By default, the docker-compose file will be generated in such a way that the Control Center will be able to connect to the locally running JHipster application out of the box. Another possible way to run the **JHipster Control Center** in development would be to develop a simple CLI that allows to start the **JHipster Control Center** server quickly. Such a CLI tool could be embedded into the JHipster package distributed on NPM.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In every JHipster app, docker-compose files are present in the `src/main/docker` folder to launch associated services such as databases, message brokers and registries using docker. Among them, a **jhipster-control-center.yml** will let the users start the **JHipster control-center** which will then be available at [http://localhost:1337](http://localhost:1337). By default, the docker-compose file will be generated in such a way that the Control Center will be able to connect to the locally running JHipster application out of the box. Another possible way to run the **JHipster Control Center** in development would be to develop a simple CLI that allows to start the **JHipster Control Center** server quickly. Such a CLI tool could be embedded into the JHipster package distributed on NPM.
In every JHipster app, docker-compose files are present in the `src/main/docker` folder to launch associated services such as databases, message brokers, and registries using Docker. Among them, a **jhipster-control-center.yml** will let the users start the **JHipster control-center** which will then be available at [http://localhost:1337](http://localhost:1337). By default, the docker-compose file will be generated in such a way that the Control Center will be able to connect to the locally running JHipster application out of the box. Another possible way to run the **JHipster Control Center** in development would be to develop a simple CLI that allows to start the **JHipster Control Center** server quickly. Such a CLI tool could be embedded into the JHipster package distributed on NPM.

@@ -24,7 +24,7 @@ Another reason is that JHipster has too many generators, this will allow a more

[guide-level-explanation]: #guide-level-explanation

JHipster have a few generators related to entities.
JHipster has a few generators related to entities.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
JHipster has a few generators related to entities.
JHipster has a few generators related to entities:

@@ -39,7 +39,7 @@ We have priorities to be used on entity generators.

Those generators and priorities will be replaced by entity focused priorities and internal methods to support the workflow. Some entity related generators may be kept for more specific purpose like prompts.

Planed priorities includes.
Planed priorities include.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Planed priorities include.
Planned priorities include:

@@ -39,14 +39,14 @@ JHipster 7 have lots of technology specific needles implemented at `generator-ba
- `addMavenPluginRepository`
- Many others

Those needles should be implemented using modular approach at the technology specific generator.
Those needles should be implemented using a modular approach at the technology specific generator.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Those needles should be implemented using a modular approach at the technology specific generator.
Those needles should be implemented using a modular approach at the technology-specific generator.


## Reference-level explanation

[reference-level-explanation]: #reference-level-explanation

Needles will be implemented as a stand-alone function having the generator as first parameter.
For convenience it will be exposed at the technology specific generator as a class member method.
For convenience, it will be exposed at the technology specific generator as a class member method.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For convenience, it will be exposed at the technology specific generator as a class member method.
For convenience, it will be exposed at the technology-specific generator as a class member method.

@@ -87,7 +87,7 @@ export default class ChildGenerator extends Generator {
}
```

Using at a non related generator:
Using a non related generator:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Using a non related generator:
Using a non-related generator:

@DanielFran DanielFran enabled auto-merge February 21, 2024 09:46
@DanielFran DanielFran merged commit b994876 into jhipster:main Feb 21, 2024
24 checks passed
@deepu105 deepu105 added this to the 8.2.0 milestone Mar 20, 2024
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.

5 participants