generator-office icon indicating copy to clipboard operation
generator-office copied to clipboard

readme has ugly table at top

Open akrantz opened this issue 6 years ago • 8 comments

image

@kbrandl Would you mind fixing this?

akrantz avatar Jul 19 '19 18:07 akrantz

@akrantz unfortunately this table is here "by design" and needs to remain (as-is). It's adding metadata for this repo so that the repo can be surfaced to users in search results within the Office Dev Portal (e.g., as shown here).

kbrandl avatar Jul 19 '19 18:07 kbrandl

Actually, here's another link that better shows generator-office in the search results when filtering by "Add-ins" and "Tools": https://developer.microsoft.com/en-us/office/gallery/?filterBy=Add-ins,Tools

kbrandl avatar Jul 19 '19 18:07 kbrandl

Can this be moved to the end?

akrantz avatar Jul 19 '19 19:07 akrantz

@akrantz I think it needs to exist at the top of the README, but I'm not certain as I wasn't involved in implementing the process that uses it.

@nokafor do I recall correctly that you were involved in adding this metadata to the top of the README in several GitHub repos (so that they'll be searchable via the Office Dev Portal)? If so, can you please answer @akrantz's question re positioning? i.e., does the metadata have to exist as the first thing in the README, or can it be moved to the end?

kbrandl avatar Jul 19 '19 19:07 kbrandl

@akrantz do you want to close this issue, per our discussion last week? To recap -- this table at the top of the README makes it so that the OfficeDev/generator-office repository will show up in search results on the Office Dev portal (when the user filters by "Tools" and "Add-ins", for example). AFAIK, it must appear at the top of the README, and while you could technically remove the table altogether, doing so would mean that this repo would no longer appear in search results within the Office Dev portal.

kbrandl avatar Jul 22 '19 17:07 kbrandl

I'd like to keep it open until we really have a resolution. I don't see much value in having these and would prefer to just remove this from the readme so it appears nicer, and then drive the issue of needing a better way for a project to appear in the Office Dev portal search results.

akrantz avatar Jul 22 '19 17:07 akrantz

Okay, that's fair. In that case, I'm re-assigning this issue to @nokafor (Sylvia Okafor); she's also requested that you send her an email to express your feedback about this table appearing at the top of READMEs throughout repos in OfficeDev, so that she can share the feedback with the appropriate folks.

kbrandl avatar Jul 22 '19 18:07 kbrandl

Is this still a problem?

millerds avatar May 24 '22 17:05 millerds