Coder Social home page Coder Social logo

Comments (7)

neojp avatar neojp commented on August 30, 2024 1

@jenweber I have submitted the PR #207 using the WP-CLI Commands page as a reference. It includes the following:

  • Added tables of contents with links to each command
  • Added anchored headings to each command
  • Added description to each command

Note: This isn't included in this PR, but I think we should add additional information about ember generate blueprints.

Screenshots

image


image


image

from cli-guides.

jenweber avatar jenweber commented on August 30, 2024 1

Thanks everyone for the help! The new page is live with several improvements from multiple people ❀️

from cli-guides.

mehulkar avatar mehulkar commented on August 30, 2024

Instead of trying to come up with a complete list, i'd recommend removing everything from the Guides and simply telling people to use ember help. Any specific issues should be filed as such.

from cli-guides.

fozy81 avatar fozy81 commented on August 30, 2024

@jenweber I'm interested to help. I've put together a work in progress PR listing all the commands. But not quite sure exactly what format we are aiming for. Do we want almost a screen dump of ember --help or add more description for each command/options πŸ€” . Anyway, happy to help, it's a really good learning experience discovering useful commands/options I've not used before πŸ˜„ - no matter what form it finally ends up in.

from cli-guides.

jenweber avatar jenweber commented on August 30, 2024

Hi @fozy81, thanks for your help! I think we could start with a screen dump, and if that seems insufficient, that’sa good signal that we need to update the CLI help text as well. We already have a page with longer descriptions for the most common commands, aimed at beginners. So this new page can be more like a reference.

@mehulkar that was my initial plan for the Guides, but the learning team has received consistent feedback that people are looking for the reference list and they go back to the old site for it. Now that we are redirecting people from the old site, I think we should cover it. I think we still need to emphasize strongly that people should use help as their first stop.

from cli-guides.

fozy81 avatar fozy81 commented on August 30, 2024

Hi @jenweber @mehulkar I've updated the PR with a screen dump of ember --help and added a note to use ember --help for the most up to date info/version. It looks okay on mobile, I added line breaks into the bash output at around 60 characters per line so it fits better on to a small screen without overflowing.

Does this fulfill the feedback/issue - let me know if anything needs changing or what your reflections on this change are? Do you think there are specific reference page(s) from the old CLI website we need to re-create to fulfill the feedback people have been providing? Perhaps the ember commands table on this page?

Slightly off topic, one thing that crossed my mind is that the ember guides point new users towards javascript, html and css tutorials/info but it's feasible that our audience 'who knows enough to have built a simple HTML/JavaScript (or JQuery) app' may not be familiar with CLI tools. What do you think about pointing new users towards a CLI tutorial to help gain familiarity with the CLI itself, if required?

from cli-guides.

neojp avatar neojp commented on August 30, 2024

@jenweber Now that we have merged #207, I have sent a new PR with the remaining ember generate blueprints on #208.

Hopefully with this we can finally close this issue.

I'd love to figure out a way to automate this process to avoid this manual process if the documentation for the scripts change, but that could live under a separate issue if we ever get to that.

from cli-guides.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.