writethedocs / www

The main website for Write the Docs.
http://www.writethedocs.org
Other
1.33k stars 511 forks source link

Adding a page about creating a professional portfolio #1904

Closed djwfyi closed 1 year ago

djwfyi commented 1 year ago

Portfolios come up pretty frequently in the WTD Slack community in various channels. This PR page adds some of the common discussion points that come up for creating portfolios.

The page is located in the Hiring Guide folder and included in that page's Usefiul Skills heading.


:books: Documentation preview :books:: https://writethedocs-www--1904.org.readthedocs.build/

silopolis commented 1 year ago

How timely! 😍👌 Thanks a ton for creating this important piece 🙏🙏🙏

djwfyi commented 1 year ago

Comment from slack

djwfyi commented 1 year ago

Worth cross linking

I think it's a good idea, but my skill at creating internal links in these docs is lacking. It didn't go well when I tried it for the SEO page. Eric wound up creating a top link (rather than a deep link) to the page I was referencing. If you know how to add a deep link to that heading, please do! Or tell me the syntax to use. (I tried adding a :ref: tag and referencing that, but it didn't work on the SEO page.)

plaindocs commented 1 year ago

This works for me

diff --git i/docs/topics.rst w/docs/topics.rst
index 0313410a..929b29b5 100644
--- i/docs/topics.rst
+++ w/docs/topics.rst
@@ -291,6 +291,8 @@ Getting hired
 - |:newspaper:| `Creating a doc portfolio </blog/newsletter-september-2017/#doc-portfolios-a-perpetual-conundrum>`__
 - |:newspaper:| `Writing a resume </blog/newsletter-august-2017/#what-resume-advice-is-the-right-resume-advice>`__
 - |:newspaper:| `Putting together a portfolio </blog/newsletter-october-2016/#putting-together-a-technical-writing-portfolio>`__
+- |:newspaper:| `Maintaining a portfolio </hiring-guide/portfolios/>`__

and yes it's fiddly! Should maybe add a note in #1152

plaindocs commented 1 year ago

Or did you mean vice versa? I think this way is more useful.

djwfyi commented 1 year ago

OH! You meant adding a link to this new page to the topic guide. :smile:

plaindocs commented 1 year ago

I did indeed ;-)