-
Notifications
You must be signed in to change notification settings - Fork 12
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
Replace Pack plugin info with link #2
Conversation
It wasn't clear (to me anyway) that the Packs needed to be downloaded and installed before I could associate a device with a project. The Pack plug-in installation page is very clear though so I have removed Pack plugin information from this page and linked to that one. Hope that's OK.
I'm not sure I understand the logic behind this pull request. The link was already there, just that before and after it there were some more explanations. Why do you think that removing them helps? |
The original page tells me that I need the Pack plugin installed and... "If not present, it is recommended to first read the Packs manager documentation page where installation details are also provided." So I check that it is installed and because it is (it's installed with the all the other GNU ARM Eclipse packages) I proceed to the next section. In the next section I wonder why I can't see any devices. And the reason (which I find out by digging further on the site) is that I haven't been through the process of downloading and installing the packs. My logic for removing the text was that it's better to link to the complete Pack install guide with a short, accurate context as to why you need to read it, than to let the reader think that the prerequisites have been met and be confused when they haven't. Feel free to ignore/modify though :) Another option is to just remove the text "If not present," |
ok, but the next section asked to install the necessary packs:
if the phrasing is not clear, then we should fix it.
yes, if you think it helps, we can do this. the idea is that I would make the text more explicit, not remove it completely. |
You already have explicit (and very clear) instructions here: https://gnu-mcu-eclipse.github.io/plugins/packs-manager/ IMHO it doesn't make sense to duplicate those instructions into this page. |
no, I don't want to duplicate that page, all I want is to be sure that the packs plug-ins are installed and the related cmsis packs are loaded, otherwise the Devices tab will be empty. if you can improve the text to make this obvious, please let me know, but I doubt that a simple reference to the other page will do it. |
Fair point. Let me have another go at it. |
Re-reading the page I stick by my original change. The prerequisites are:
All of which can be encapsulated in a single sentence, or maybe bullet points. Trying to explain these steps in more detail on this page to avoid the reader going through the Packs manager install process is needless duplication of your already excellent guide. Ultimately it's only a very small point, I figured it out in the end as I'm sure others will. |
It wasn't clear (to me anyway) that the Packs needed to be downloaded and installed before I could associate a device with a project. The Pack plug-in installation page is very clear though so I have removed Pack plugin information from this page and linked to that one. Hope that's OK.