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.

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

Jump to bottom

The CDT user manual chapter "Getting Started" needs to be updated. #992

Open
jonahgraham opened this issue Jan 7, 2025 · 1 comment · May be fixed by #1056
Open

The CDT user manual chapter "Getting Started" needs to be updated. #992

jonahgraham opened this issue Jan 7, 2025 · 1 comment · May be fixed by #1056

Comments

@jonahgraham
Copy link
Member

The CDT user manual chapter "Getting Started" needs to be updated because of #965 and other changes.

The sections "Creating a simple application" and "Creating a Makefile project" are basically the same. Both describe creating an MBS Makefile project. Only the first section has illustrations included.

I would propose these sections:

Core Build System
Creating a CMake project
Creating a Core Build Makefile project
Creating a Managed Build Makefile project (a cleaned up version of "Creating a simple application" and "Creating a Makefile project")

Description edited from comment originally posted by @ewaterlander in #965 (comment)
@jonahgraham jonahgraham mentioned this issue Jan 7, 2025
Closed
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 8, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
5140906 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Check-in generated htm files
  - this makes it easier to see if anything changes
    unexpectedly
  - help in the developement Eclipse "just works" as developers
    don't need to generate anything
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)

Prerequisite of eclipse-cdt#992
@jonahgraham jonahgraham mentioned this issue Jan 8, 2025
Merged
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 8, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
0ab072a 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Check-in generated htm files
  - this makes it easier to see if anything changes
    unexpectedly
  - help in the developement Eclipse "just works" as developers
    don't need to generate anything
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)

Prerequisite of eclipse-cdt#992
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 8, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
089f597 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Check-in generated htm files
  - this makes it easier to see if anything changes
    unexpectedly
  - help in the developement Eclipse "just works" as developers
    don't need to generate anything
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)

Prerequisite of eclipse-cdt#992
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 8, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
992f98e 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Check-in generated htm files
  - this makes it easier to see if anything changes
    unexpectedly
  - help in the developement Eclipse "just works" as developers
    don't need to generate anything
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)

Prerequisite of eclipse-cdt#992
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 8, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
2fed9cf 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Check-in generated htm files
  - this makes it easier to see if anything changes
    unexpectedly
  - help in the developement Eclipse "just works" as developers
    don't need to generate anything
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)

Prerequisite of eclipse-cdt#992
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 8, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
7d905cf 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)
- New profile "asciidoc-auto-refresh" which will auto build the
  files as edited.

Prerequisite of eclipse-cdt#992
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 14, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
8f1e3f9 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)
- New profile "asciidoc-auto-refresh" which will auto build the
  files as edited.

Prerequisite of eclipse-cdt#992
jonahgraham added a commit to jonahgraham/cdt that referenced this issue Jan 14, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
4b28dfb 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)
- New profile "asciidoc-auto-refresh" which will auto build the
  files as edited.

Prerequisite of eclipse-cdt#992
jonahgraham added a commit that referenced this issue Jan 14, 2025
@jonahgraham
Generate more of the documentation with asciidoc and automate more
9aa3144 
- Migrate all getting_started from html to adoc
- Document (in README.md) notes on migrating html to adoc
- Reorganize generation of adoc slightly so that
  - all directories can be generates at once
  - output suffix changed to htm so that migrated files
    exist at the same URL on help.eclipse.org
- Add generation to the cleanliness checks to ensure that the
  html matches adoc
- Manage the adoc headers with a script as that is a large section
  of copy-pasted code on each adoc file (see README + adoc-headers.txt)
- Move maven version info to pluginManagement (consistency with other
  maven plug-ins)
- New profile "asciidoc-auto-refresh" which will auto build the
  files as edited.

Prerequisite of #992
@ewaterlander
Copy link
Contributor

I will start working on this issue.

ewaterlander added a commit to ewaterlander/cdt that referenced this issue Jan 23, 2025
@ewaterlander
Getting Started documentation update.
c429387 
* Put Core Build and Managed Build items in separate topics.
* Added two images to Creating a CMake project.
* Added new pages about creating a CBS Makefile project, using
  existing code, and the launch bar.
* Renamed "Creating a simple application" to "Creating a Managed Build
  System Makefile project" and replaced two images.
* Removed "Creating a Makefile project", because it was duplicate
  information.

Fixes eclipse-cdt#992
@ewaterlander ewaterlander linked a pull request Jan 23, 2025 that will close this issue
Open
ewaterlander added a commit to ewaterlander/cdt that referenced this issue Jan 24, 2025
@ewaterlander
Getting Started documentation update.
9526216 
* Put Core Build and Managed Build items in separate topics.
* Added two images to Creating a CMake project.
* Added new pages about creating a CBS Makefile project, using
  existing code, launch bar, building, running, and debbuggin
  a project.
* Renamed "Creating a simple application" to "Creating a Managed Build
  System Makefile project" and replaced two images.
* Removed "Creating a Makefile project", because it was duplicate
  information.

Fixes eclipse-cdt#992
ewaterlander added a commit to ewaterlander/cdt that referenced this issue Jan 24, 2025
@ewaterlander
Getting Started documentation update.
378d553 
* Put Core Build and Managed Build items in separate topics.
* Added two images to Creating a CMake project.
* Added new pages about creating a CBS Makefile project, using
  existing code, launch bar, building, running, and debbuggin
  a project.
* Renamed "Creating a simple application" to "Creating a Managed Build
  System Makefile project" and replaced two images.
* Removed "Creating a Makefile project", because it was duplicate
  information.

Fixes eclipse-cdt#992
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Getting Started documentation update. ewaterlander/cdt
2 participants
@jonahgraham @ewaterlander