As a part of #2533684: Create 'Documentation' Section we are getting ready to migrate existing documentation into the new section.
During the migration:
- the content type for documentation will be changed from 'book page' to 'documentation page' and 'documentation guide'
- documentation will be split by major Drupal version (#2587331: Split documentation per Drupal version)
- documentation will be reorganized into a new structure (#2744915: Define new structure for documentation)
- book outline will be replaced with 'guides' system, where guide is a collection of documentation pages with own menu and maintainer(s), who have additional permissions to take care of the content inside of the guide
We will start by migrating 'generic' documentation, such as Understanding Drupal, Structure guide, etc. Documentation for contributed projects will follow in a couple of weeks.
Progress:
- Orphaned pages
Understanding DrupalInstallation GuideAdministration & Security GuideStructure GuideMultilingual GuideMobile GuideTheming GuideDevelop for DrupalSite Building Guide: #3443035: Review and migrate 'Site Building Guide' bookTo be migrated: #2832228: Review and migrate 'To be migrated' bookMigration archive: may be pages already decided to delete.#3515539: Identify Migration archive page for delete or needs migrationReference: #3457287: Decide what to do with 'Reference/Snippets' & #3457288: Decide what to do with 'Reference/Troubleshooting'Tutorials and site recipes
How to help
If you'd like to help during and after migration, sign up to maintain specific part of the documentation over at #2682083: Recruiting guide maintainers for documentation
Information for contributed project maintainers
If documentation for your project exists somewhere in Site Building Guide or any other documentation book, we will create a new documentation guide, and migrate existing docs into it. If you are project maintainer, you will be added as a guide maintainer, so that you could modify guide, its menu, its contents, add other guide maintainers, etc.
Please be prepared to spend a bit of time in the next few weeks modifying your documentation post-migration. If there is specific time before/after which you want us to migrate documentation for your project, please let us know in the comments.
NOTE: Existing order of pages set via Book outline will be lost during migration. You will have to rearrange menu of your new documentation guide to set desired order of the pages.
The hierarchy of the pages inside of the guide is flat, which means there are no 'child' pages, all of them are on the same level inside of the guide. We strongly encourage you to merge pages together to create guides with fewer, longer, pages.
Comments
Comment #2
tvn commentedComment #3
tvn commentedComment #4
tvn commentedComment #5
tvn commentedComment #6
tvn commentedComment #7
saurabh.dhariwal commentedComment #8
gisleThe old user contributed documentation was a Wiki and it was very simple to correct or add missing documentation.
I've looked at the new documentation pages that are being rolled out, and it looks like this is no longer the case. Instead, each page is assigned a "maintainer" and there is a button to "discuss".
If this how you plan things to stay, I fear that this will not be sustainable. Some pages are bound to become abandoned as maintainers lose interest or just move on.
When this happens to projects, there is both a temporary fix (patches posted to the project's issue queue), and a procedure for repairing the situation.
If the user contributed documentation is no longer going to be a Wiki, how are you going to deal with abandoned documentation pages?
Comment #9
gisleIt also looks like you're removing the old user created documentation pages.
There is two problems with this approach:
By all means - create all the new pages you want to create, but please stop removing the old pages until you understand what they're used for and from where they are linked to.
Comment #10
tvn commentedre: #8 - documentation will stay a 'wiki', as in pages will be editable by any user as they are now. Permissions are restricted at this moment while we migrate initial pages and test that migration script and the new content types work the way we want them to. Permissions to be edit will be opened up shortly, definitely before we migrate bigger documentation books.
Each page is not assigned a maintainer, only 'guides' - collection of pages on specific topic - are. Issue linked at the top of the issue summary and various child/related issues provide more information about the functionality we are moving towards and why.
Re: #9 - we are not removing pages. Migration script changes the content type of the node, but the author/history of revisions/comments/url are all preserved. That said during the audit of documentation pages we did identify *obviously* outdate pages, empty pages, etc. which will not be migrated into the new system. Those pages will be kept as book pages until the migration is finished and people had a chance to highlight if something relevant is missing and should indeed be migrated.
Comment #11
tvn commentedStatus update: we kicked off migration with docs about Drupal.org, to test out migration script and fix any potential bugs before we start migrating documentation about Drupal. Found a few minor things and fixed them. I should start migrating 'Understanding Drupal' guide soon-ish.
Comment #12
tvn commentedUnderstanding Drupal book now done. Content from it went into the two new guides:
https://www.drupal.org/docs/7/understanding-drupal
https://www.drupal.org/docs/7/choosing-drupal-version
D8 versions of those need to be created #2774809: Write documentation for Drupal 8
Comment #13
joachim commentedIs there an issue for migrating the contrib modules documentation?
I am very concerned about the migration discarding book hierarchy data. There are many modules where this is a vital part of the content, and losing it will mean a lot of manual work to restore it. Eg Feeds https://www.drupal.org/node/622696, and Flag https://www.drupal.org/documentation/modules/flag, to pick just two modules at random.
Comment #14
tvn commentedThere is not a separate issue for contrib, this one covers all migration. We are not migrating contrib docs yet.
Regarding the hierarchy, flat hierarchy does not mean that all of the pages about a module will be in a single guide. We will create sub-guides to preserve hierarchy whenever makes sense. E.g. in the Feeds example there can be an overall Feeds documentation guide, with sub-guides: The site builder's guide to Feeds, The developer's guide to Feeds, Contributed plugin modules for Feeds.
Comment #15
tvn commentedUpdating status. Installation guide is done. Admin and security guide is in progress.
Comment #16
andypostHaving so big fonts require to make width to be wider
It's really hard to read https://www.drupal.org/docs/8/modules/features
Comment #17
joachim commented> Regarding the hierarchy, flat hierarchy does not mean that all of the pages about a module will be in a single guide. We will create sub-guides to preserve hierarchy whenever makes sense. E.g. in the Feeds example there can be an overall Feeds documentation guide, with sub-guides: The site builder's guide to Feeds, The developer's guide to Feeds, Contributed plugin modules for Feeds.
Have you had a look at the Flag documentation? That nests quite deep. I'm really not happy about the prospect of that structure being lost.
Is there an issue where the contrib module docs migration is being worked out?
Comment #18
Markéta commentedComment #19
Markéta commentedComment #20
darol100 commentedI have the same question.
Comment #21
tvn commentedQuoting from my comment #14:
Comment #22
darol100 commentedoopss... I should have read everything.
Thank you
Comment #23
tvn commentedUpdating migration progress.
Comment #24
joachim commentedPlease don't migrate docs for Flag until the matter of what to do with the deep hierarchy is resolved.
Comment #25
mjhoy commentedHi. I just wandered over to the Drupal 8 install docs, thinking I would test it out today, and there's hardly anything there. What am I missing?
https://www.drupal.org/docs/8/install
Comment #26
tvn commentedMost of existing content in the Installation guide was Drupal 7, content for D8 still needs to be written.
Comment #27
mjhoy commentedIsn't the content written already? Why not just link to https://api.drupal.org/api/drupal/core%21INSTALL.txt/8.1.x rather than have a confusing, broken-looking documentation site?
Comment #28
klausiOpened #2811365: Code blocks should be able to show lines with 80 characters and #2811359: WYSIWYG editor breaks code formatting.
Comment #29
gisleThe "comment" feature of the new documentation has a pretty brain-damaged text format.
<p>markup.<p>and<a ...>as plain text.For an example of the brain-damage, see my comment here.
Comment #30
joachim commentedI assume no links is to prevent spam, but we really need to be able to link to other docs pages, issues, and API pages.
Comment #31
gisleWe have the "Confirmed" user role to prevent non-trusted users from abusing their account here (to post spam and other unappreciated junk). I assume that anyone with the "Confirmed" user role can (and should) be trusted with posting links?
Comment #32
jurriaanroelofs commentedI wanted to link some clients in need of support to the "updating modules/themes" documentation but it's missing any information about the update manager:
https://www.drupal.org/documentation/modules/update
I don't want to make my clients bother with FTP and finding passwords etc. because Drupal has this great solution for updating non-interactively using the update manager, is there any reason it's excluded in the official docs or is it something we can add there?
link in old docs: https://www.drupal.org/documentation/modules/update
Comment #33
pukku commentedAccording to the summary at the top, the installation guide has been migrated. However, when I try to view the installation system requirements, it's basically empty. What version of SQLite is compatible with Drupal 8?
Comment #34
andypostrequirements redirected to https://www.drupal.org/docs/7/system-requirements/overview
>SQLite 3.7.11 or higher
Comment #35
tvn commentedRegarding the comments, we are aware of the problem and plan to address it in the next week or so. Here is the issue #2817225: Stop stripping newlines and other formatting from comments on documentation pages.
Which guide/page were you linking to that is missing this info?
There is no reason to exclude it, https://www.drupal.org/documentation/modules/update just hasn't been migrated into the new system yet.
Most of the existing documentation content is about Drupal 7 and hence has been migrated into https://www.drupal.org/docs/7. Drupal 8 documentation located at https://www.drupal.org/docs/8 is still far from complete. Feel free to add information when you see it missing in D8 docs. Here is related issue #2774809: Write documentation for Drupal 8.
Comment #36
christopher james francis rodgers commentedNotice to drupal.org documentation creators
Do not link to any of the new Documentation pages, using the textual 'friendly URL' in the address-bar. That URL will change every time someone decides to change the page's 'title'.
If you want to link to one of the new drupal.org documentation pages, login to drupal.org, (or register, and confirm your registration in your eMail), click the "Edit" button for the page you want to link to.
Remove the "/edit" portion of the URL that you will then see in your browser's address-bar for that page.
The permanent URL that you must now use to link to any new drupal.org documentation page will be similar to https://www.drupal.org/node/###### with numerals instead of '######'.
---
"Though a bit ranty," admittedly, that issue is here [2824170]
Comment #37
tvn commentedWe are currently migrating core modules documentation from the Site Building guide.
Comment #38
slashrsm commentedDrupal 8 media team has been maintaining "D8 media guide" on GitHub: https://github.com/drupal-media/d8-guide. The reason for that is the fact that having docs in some common format (Markdown in our case, but not limited to that) makes it easily portable and re-usable. Having it in a git repo is also beneficial since you have it versioned, one can easily clone and compile it in full locally, we get to use same contribution workflows as we're used to in our every-day life, ...
But there are also downsides (like always:)). Having it on GitHub/GitBooks and not on drupal.org causes big discover-ability problem, which we would like to solve. However, we wouldn't like to move away from current format.
I noticed that D8 user guide uses AsciiDoc. Would it be possible to do something similar for Media guide? Are there any APIs that would allow us to compile and publish changes to it automatically?
Comment #39
drummThe compiled user guide still has some rough edges and does take some time for us to update. For example, #2831856: Deploy changes to User Guide modules etc.. The planned editorial process there is to update on Drupal.org when a tag is pushed. It hasn’t been fully automated yet. I wouldn’t want to add more guides like this.
If the Media guide fits into a chapter of the existing user guide project, that would work nicely.
Comment #40
joachim namysloGuess this may be the wrong place to discuss. But I used the documentation now from a newbee perspective to start learning codeing for Drupal By using this as a visitor of Drupal org I find it somewhat confusing that the documentation mixes d7 and d8 in the navigation trainl An example is:
https://www.drupal.org/docs/8/creating-custom-modules/naming-and-placing...
There is a link to https://drupal.org/node/1056468
So if you follow this
After changing the page the navigation trail on the right is changing and you see some d7 related things as well. I know that Drupal's docs must be extremely massive but this is a confusing behavior. Where is the place to suggest a better navigation trail? Is there any none else seeing my point or is this just a silly newbie opinion?
Comment #41
tvn commented@dinmikkith Please use 'Discuss' tab of the page in question to suggest improvements. For this particular case it seems the first page you mention simply needs to be updated. The link should go to Drupal 8 version of the documentation page 'Show all errors while developing' instead of Drupal 7.
Comment #42
SebCorbin commentedDon't know where to put this issue, but there's a problem with code block formatting on this page https://www.drupal.org/docs/7/api/render-arrays/render-arrays-overview#c...
Comment #43
drummI fixed up the markup there (using CKEditor) and added a note about this to #2741227-30: Enable CKEditor for more content types.
Comment #44
gisleI am reporting this documentation page: https://www.drupal.org/drupalorg/style-guide/grid .
(I am not allowed to edit the page, and there is no "discuss" tab or "report errors" link.)
The page refers to a "design grid" with no context and explanation about how this "design grid" is part of Drupal. Two support questions and one bug report:
This is the landing page arrived at after googling "drupal using 12 column grid". We need make sure doc pages are self-contained because every doc page is a landing page for Google. In this case, navigating up or sideways did not help me finding out how to use a 12 column grid when theming a Drupal site.
Comment #45
jcnventuraJust wanted to note that the PHP requirements for D8 can't yet be found in the /8/ section, and are only found in the docs for D7.
Comment #46
tvn commented@gisle This issue is about migrating documentation into the new system. Please open separate issues in the Documentation queue for other questions/reports.
@jcnventura Please feel free to create a new page in the appropriate D8 guide and port the content from D7 docs.
Comment #47
gisletvn wrote:
And pages in the new documentation system are broken. AFAIK, there are no such problems with the pages in the existing document system. I think you should have some sort of QA after a page has been migrated, rather then having them reported one by one.
As noted in #44 I am not allowed to edit the page, and there is no "discuss" tab or "report errors" link.
Comment #48
tvn commentedThat is because the page you are talking about is not a documentation. You are looking at the Drupal.org style guide, and page that describes grid of the Drupal.org theme. If you want to suggest improvements to the style guide, please open a new issue.
Comment #49
gisleWell, it sure looks like documentation to me (it even uses the same distinctive Ubuntu Google font and the same layout as the rest of the Drupal.org documentation - and unlike the sans-serif font stack with Verdana, etc. that is used on the parts of Drupal.org that are not documentation. (I don't think I am the only designer that uses visual clues like fonts to classify content.)
But from your kind comment, I now understand that this page really is something different™. And also that it is the the user's responsibility to know the difference.
No, I don't - not any more.
Reporting documentation issues at Drupal.org apparently requires one to understand how the cabal that manages documentation has divided the site up in twisty little documentation sub-sites, all different. This is a game I don't have the time to play.
Comment #50
tr commentedThe issue summary says:
Please clarify, you have NOT migrated my documentation (Ubercart), and if I try to migrate the documentation myself using the link (https://www.drupal.org/migrate/documentation/159733) on my bookpage (https://www.drupal.org/documentation/modules/ubercart), I receive an error message:
There is NO information or documentation about how to "select a smaller sub-set of book pages for migration" - there is only the link on my main book page that says to click and the migration will happen.
Ubercart is a major module that has been around for 10 years. It has tens of thousands of users and hundreds of book pages of documentation at https://www.drupal.org/documentation/modules/ubercart. This whole migration business seems to be focused on minor, small projects and has really ignored the needs of maintainers like me who support tens of thousands of users and several dozen projects.
It would have been really nice if you could have informed project maintainers like me when you changed the documentation system, and it would have been even nicer if you had migrated my documentation yourself after making this change - leaving it to me to discover some months later and try to migrate it myself is a little anti-social. Throwing an error because I have too much documentation is just ridiculous.
Comment #51
drummTR - you can migrate smaller batches of pages by starting at a point deeper in the book hierarchy, such as https://www.drupal.org/node/1312862.
The new documentation pages have some structural differences which don’t automate well. Such as the summary field - the migration tries picking out the first few words, but there’s a good chance that’s not a great summary. Each page should get some review by a person as it is migrated, unfortunately that does add up for more-documented projects.
Comment #52
Naikalongus commentedComment #53
Naikalongus commentedComment #54
gisleNaikalongus,
here are some hints about how do use the issue queue:
To me it looks like you tried to indicate that you need some sort of support regarding Documentation. If that is the case, open up a new issue in the Documentation project. Explain clearly why you are creating the issue and what you request.
Comment #56
drummzumznm - please do not post test content.
Reverted to a previous version.
Comment #57
lmirabile commentedComment #58
lmirabile commentedChange "less" to "fewer." Also changed "but" to a comma - but not sure that's an improvement after all.
Comment #59
lmirabile commentedComment #61
avpadernoI unassigned the issue, since tvn is no longer active here.
Comment #62
hansfn commentedHm, most of the general documentation is migrated now and this issue has stalled.
Should we close this issue and create a separate issue for contributed modules? Many maintainers have not migrated their pages yet. Maybe because they didn't write the current book page? (The maintainer might focus on the project page.)
Comment #63
hansfn commentedVery little feedback on my comment from 1st of August ;-)
If we create a separate issue for contrib modules we could make a task list (in the issue summary) based on the list of modules on https://www.drupal.org/documentation/modules/contributions I think that could help, but most likely we just don't have the resources to get the job done.
Comment #64
gislehansfn wrote:
+1 from me.
There is a problem with that list. About 9 months ago i migrated all the documentation for the modules I'm the maintainer for. Almost none of it appears in that list.
On most of them, there is a box on the top saying:
Example: https://www.drupal.org/docs/7/modules/advanced-help
I'm not sure how this review process is supposed to work, but I don't think it is working now.
Comment #65
hansfn commentedThe review process doesn't working because the guide maintainers, eojthebrave and me in this case, aren't notified in anyway that there are guides that need review. I have complained about this to drumm in some issue earlier. Even if we actively look for guides that need review, it's "impossible" to find them because the (group) content list only provides a "published" filter, not a "reviewed" filter. If you have time / energy, please create an issue for this.
PS! I'm happy to "review" your modules guides today - just sent the list directly to me.
Comment #66
gislehansfn wrote:
I've created a child issue in issue queue for Drupal.org customizations, see: #3017611: Migrated documentation for contributed projects does not show up in the new list of documentation.
Comment #67
drummI’ve opened migration for the remaining books and added links to the issue summary:
Migrating or deleting book pages directly helps the Drupal.org migration past Drupal 7. The book module and content type will not be on the site in the future.
Now-useless pages can and should be deleted. I think https://www.drupal.org/migration-archive might have been the place to collect pages to be deleted.
Comment #68
drumm(fixing link)
Comment #69
quietone commented@drumm, thanks for making a new list.
I have skimmed through all those except "Migration archive" and did not find anything that I thought need to be moved to the new documentation system. I think this is also supported by no one else has come along and moved pages either.
Because you said that "Migration archive" was probably for items to delete I tried to move "Reference" there. Instead I get get this error, "You tried to migrate over 30 child nodes. Usually a guide consists of a smaller number of pages. To prevent possible mistakes, please select a smaller sub-set of book pages for migration at a time." I tried 3 more times with smaller sections but kept getting the same message. So, it there some way to make it easier to move them?
I suppose that question applies to deleting the pages as well. Although, I must admit I don't feel that I have the knowledge to delete community history.
Comment #70
hansfn commentedI think that is a too broad statement. Firstly, there is a lot of content under these guides. I skimmed too and found a lot that is useful, but needs updating. Secondly, people are finding the pages using search and are happy with that. The don't care which system the pages are in.
Anyway, we aren't interested in moving this mostly D7 stuff to the new system. We don't have the resource to do it properly. So either we delete or we make a static archive of the pages. (A minor clean-up before archiving is necessary.)
Comment #71
ressaThanks for looking at this. Some pages on the https://www.drupal.org/to-be-migrated list have been migrated, for example:
OLD
Disable Drupal (>=8.0) caching during development
https://www.drupal.org/node/2598914
NEW
Disabling and debugging caching
https://www.drupal.org/docs/develop/development-tools/disabling-and-debu...
Since the old page can now be deleted and removed from https://www.drupal.org/to-be-migrated, should we add a new "Page status" called "Migrated", or should I create an issue and request deletion of the old doc page? Or is there another method?
Comment #72
drummThe reference book does look like it has a lot that can be deleted, and may have some hidden gems.
I'd like to go ahead and bulk delete:
and their child pages. The PHP input format and block visibility are anti-patterns now.
I deleted https://www.drupal.org/node/2598914 and replaced with a redirect for the new page, thanks ressa.
We do need child issues like #2832228: Review and migrate 'To be migrated' book for batches of pages that are achievable. Each page can be:
Comment #73
quietone commented@drumm, Deleting those sections makes sense to me.
Yes skimming is a broad statement. What I did was go through an overwhelming majority of the pages. I was relying on the title and the heading to be indicators. And I did not keep track of the tens of pages that I read more closely. I was focusing on finding pages that I thought were worth saving.
If you list those pages then we can work on were to move them to.
I have no evidence to support that. What I do know is that there are issues in the core queue for correcting links to any of the 'older' documentation.
I have made some issues as suggested.
Comment #74
quietone commentedIt may make sense to take a different approach. Instead of a small group hunting for pages to keep it could be better to ask the community. Say, make an issue that section X will be deleted by some date. And invite people to provide links to the pages they find useful.
Comment #75
avpadernoChecking which pages in the TO BE MIGRATED section are worth to migrate seems a time-consuming activity. There could be already documentation pages that cover the same topic, the covered topic is obsolete / not relevant anymore, or the information provided is not (anymore) correct.
Even with more people doing the task, it could take time to handle all those pages, or even to agree on what to do which every one of those pages.
Comment #76
hansfn commentedI agree with apaderno - we should minimize the effort used to clean-up.
If quietone and ressa create issues with suggested deletions, I'm happy to review (and delete). Then we are only 3 people "wasting" our time.
It helps with "task" issues like https://www.drupal.org/project/documentation/issues/3441968
@drumm: Yes, go ahead and delete PHP block snippets, PHP block visibility settings, PHP page snippets
Comment #77
quietone commented@hansfn, What is your plan for these pages? Can you share the links?
Comment #78
hansfn commentedMy plan / wish is to remove as much as possible because we 1) don't have the resources to update them and / or 2) IMO we add too much non-Drupal specific docs. That doesn't mean that these pages aren't useful ...
In general, to repeat myself, the problem is what to do with D7 specific stuff. We have migrated a lot already that we maybe would deleted now.
Comment #79
drummThese are now deleted:
Code used was:
So deleting more trees of pages is technically straightforward.
Comment #80
drummAnd agreed on this not being an ideal way to spend time, but this is what we need to do whenever there is a migration to something new. There is twice as much technical debt as long as there are 2 ways to do documentation. Unless we bulk delete everything or auto-migrate outdated/etc book pages to the current system, there's unfortunately no way around the sheer volume of docs that were a good idea at the time.
Comment #81
hansfn commentedI get overwhelmed when I start looking at this. So much nice stuff contributed over the years, but auto-migrating it will probably just create a maintenance nightmare.
Anyway, @drumm could you delete all sections named something with D5 / D6 Migration archive? Maybe all of it is D5 / D6, but quicker to review when the obvious stuff is gone.
Comment #82
hansfn commentedComment #83
drummAs I completed #3442307: Decide what to do with 'Tutorials and site recipes' I added 3 new capabilities:
Comment #84
drummComment #85
drummDone, and I’ve reviewed & completed the deletes requests in the child issues.
Comment #86
quietone commentedI looked more closely at the Migration archive tonight. It mostly for Drupal 5 and 6 with some Drupal 7 or 8 mentions, but all outdated. The exception could be the archive of past events. There might be community history there that is not anywhere else. For example this page lists the developers who were at the sprint in Antwerp 2005.
Comment #87
avpaderno2008-03-03: DrupalCon Boston 2008 > Contributing to Drupal: A guide for everyone should allow to download slides, but all the given links return a 404 error.
Comment #88
quietone commentedSince there are child issue, adding meta to the title.
The links mentioned in #87 are for lullabot.com, so d.o never stored that data.
Comment #89
avpadernoI meant that a page giving only three links which return a 404 error is not much helpful. It could be probably removed too.
Comment #90
drummAgreed the past events should be migrated.
I updated https://www.drupal.org/node/233045 to removed the dead links.
The migration tooling so far has been really geared toward discouraging huge hierarchies of pages, but this section does greatly benefit from hierarchy, and should be migrated with some of it. I may be able to do it with some manual work to get additional automation going. In the meantime:
Comment #91
hansfn commentedIs there some way we could migrate the events to d.o - community/events/past-events The content itself is probably not that useful, but the fact the events took place is nice to preserve.
And maybe all the Google Summer of Code events could be removed - we have https://groups.drupal.org/google-summer-code
Comment #92
drummSome of the old events looked like they would be a bit large to flatten into a single page, which would be required for moving into community events.
We also need to figure out the best way to handle groups.drupal.org, which could end up being a static archive. I wouldn't move anything there. That did lead me to find https://www.drupal.org/community/contributor-guide/reference-information..., where those pages could land.
Comment #93
hansfn commentedI was thinking just keeping the title - really. Looking at https://www.drupal.org/node/46559 (as an example) the sub pages doesn't have much value.
Yes, if History of Google Summer of Code was turned it a doc guide, you could just move the GSOC stuff there.
Comment #94
quietone commentedFound this issue about pages in the 'Migration Archive'. #1243274: Plan to archive DrupalCon/event and GSOC/GCI content from drupal.org. I haven't read it in depth and am adding this comment as a reminder to do so.
Comment #95
quietone commentedComment #96
quietone commentedJust updating the IS to strikeout the recent fixes.
Comment #97
drummI think the only remaining work here and in child issues is for me to automate bulk moving the remaining 5,806 book pages.
Of course, if there is any remaining that is outdated or duplicitous, and can be deleted, please call that out and that can be done.
Comment #98
drummI got together a quick script to migrate book hierarchies and have migrated:
Comment #99
drummNow that all books have been triaged in child issues, we are left with 123 orphaned book pages. There’s some gems like https://www.drupal.org/teapot that should have a place to land, and others that can be deleted.
Comment #100
quietone commented@drumm, can you supply the list of links?
Comment #101
drummThe orphaned pages are now at https://www.drupal.org/node/3522465
I took a first pass through deleting placeholders, obvious D6 & earlier, and a couple terrible security ideas. 101 pages remain
Comment #102
quietone commentedDeleted the docs for unsupported project
Edit: and one at the end
Comment #103
quietone commentedCreated an issue in these projects, that have a D8 stable release, to migrate the docs.
Forward module - #3522627: Migrate module documentation from old book style
GA Push #3523786: Migrate documentation from old book-style
Module - Visual Website Optimizer #3523831: Migrate module documentation from old book style
Single Page Apps /#3523830: Add documentation page to the contributed module guide
Term Merge #3523829: Migrate module documentation from old book style
Comment #104
quietone commented@drumm, The can be deleted but I don't have edit accees, the bitcahce project is unsupported.
https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib...
https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib...
Comment #105
quietone commented@drumm, I deleted the pages for "unsupported modules and modules only compatible with Drupal 6 or earlier" for the list of orphaned list here and the Contributed module documentation archive.
What about the pages for modules that do not have a stable D7 release?
Comment #106
eojthebraveI deleted a couple pages that had docs on how to use jQuery which are readily available elsewhere on the internet, and some pages related to the obsolete Dreditor browser extension.
Comment #107
drummI did a quick pass through the orphaned book pages (https://www.drupal.org/node/3522465) and deleted a couple of pages for themes that didn’t have D7 or later versions.
And those have been deleted too, thanks!
I think we have to keep those for now, there will be plenty of people with D7 sites that they need to figure out, and documentation has potential to help.
Comment #108
ressaIt's really great with all the clean up, though many Drupal 7 doc pages indexed in search engines now give a 404, since they have been deleted, without having a redirect to a replacement page, probably because there wasn't one.
This is unfortunate, since these pages may both be linked to from other pages on the internet, or on drupal.org, and the topics are still themselves relevant in Drupal 11, 12 etc. so people will still be looking for the info.
It's Drupal 7 pages like these:
https://www.drupal.org/node/1995428
Step 4 - Rename default.settings.php to settings.php
Install Drupal 7 in one-minute (or Drupal 6) Using Webhost Control Panel ... Step 4 - Rename default.settings.php to settings.php · Step 5 - Putting WAMP ...
https://www.drupal.org/node/2608620
Increase Maximum File Size
11 Jul 2017 — Although many other PHP settings are configurable by using ini_set() in the settings. ... Administer user profiles in Drupal 7 · Administering ...
As I see it, there are two options:
Handcraft precise redirects
Either add a redirect to the corresponding page, if it exists, or a fitting section or page on drupal.org. This is labour intensive, and may not be realistic. Though, it could be considered for the top 50 of 404'ing Drupal 7 documentation pages?
Do an automatic search
If a node is not present on drupal.org -- if possible, do a look up to somehow get the title of the deleted node, and do a search like https://www.drupal.org/search/site/Increase%20Maximum%20File%20Size?f%5B..., perhaps with a text like "Sorry, this page is gone, but we did a search, maybe it can help?"
Comment #109
drummWe can continue putting redirects in by hand. Where should the two pages you linked go to?
We do keep records of deleted nodes, but now is not a good time to engineer new functionality as we’re migrating the site. That is something we could build once documentation is fully migrated, if the search for the previous page title is tested and shown to be useful.
Comment #110
christopher james francis rodgers commentedIf I recall Correctly, The page "Install Drupal 7 in one-minute (or Drupal 6) Using Webhost Control Panel", was Written by me , and I had wanted it deleted anyway. because it was completely outdated. My Opinion, get rid of it. thank you. I would have deleted it myself, years ago, but I did not have that level of authority.
The page "Increase Maximum File Size", If I remember correctly, Was a huge mass of mostly irrelevant comments, But which terminated with a detailed explanation of mine, on how to ' Definitively' achieve an increase of file size, Keystroke by keystroke, mouse click by mouse click.. Addressing new bees common mistake of saving INI files. as Ini.txt file in windows. and other similar newbie errors, related simply to day-one-drupal-users lack of experience.
Aside from my detailed guide, which was actually in 2-parts, but I forget The differentiation between my two parts, and why I was compelled to have 2-parts... Anyway,If I were you, I would let that page fade away into history. If you were to look at it, you might recognize what I am talking about, and you might pull my new-b information out into a brand new how-to guide, but aside from that, please send it to oblivion.
"All the best; intended." ~ Grandpa Chris ..An ongoing Drupal 7 reliant individual : o )
Comment #111
ressaThanks for a fast reply @drumm. I have experienced a fair number of drupal.org 404's recently, after doing a search for Drupal stuff in the search engines lately, and my best guess was that a bulk deletion had been done, without redirect. When this issue appeared in my dashboard, I was reminded of it.
So those two pages are just examples I quickly looked up, to use as examples as dead links, and I don't have an opinion on a redirect, sorry.
Until the new Drupal is launched (and possibly automated search on title?) we could have a "404 Not found documentation pages" issue, where we continually add 404's, and then set up redirects?
Comment #112
ressaThanks for sharing @christopher james francis rodgers :)
Though in this case, the question is not so much about resurrecting pages, but making sure that users are redirected to a page or section about the topic. So a user may not be looking for a one-minute set up, but info about "default.settings.php" and "settings.php" and find that link in the search engine. But it's a dead end on drupal.org. So we could instead redirect them to something that resembles that subject the most.
For the second example I used, it could be redirected to https://www.drupal.org/docs/8/core/modules/file/overview.
Comment #113
ressaAnother thing: It might be worth considering adding a "This is archived/old content" banner or something, like the warnings that api.drupal.org just got, making it clearer that some of these are old or archived documentation pages. It could be added automatically at the top of all pages under certain paths? See for example, a page like this:
https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-archive/contrib-modules-for-building-the-site-functionality/dates-and-events/datecalendar/drupal-6-datecalendar/date-locale-time-zonehttps://www.drupal.org/docs/extending-drupal/contributed-modules/contrib...
It says:
... so a user may easily miss that this doc page is for an older version. A rule could be, that since it's under
https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-archivea message like this could be shown at the top of the page?Comment #114
drummWe have a notice like that for D7 documentation already. For example: https://www.drupal.org/docs/7/understanding-drupal
https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib... is more of a lost & found of potentially-unmaintained documentation that could still use triage. For example, https://www.drupal.org/docs/extending-drupal/contributed-modules/contrib... has a supported version compatible with Drupal 11, and that documentation has a good chance of being relatively current.
The only thing needed to close out this issue is triaging the orphaned book pages at https://www.drupal.org/node/3522465
Comment #115
ressaAh yes, and that works well, alerting users that this is for an old version, Drupal 7.
Could we get a similar banner for pages under
https://www.drupal.org/docs/extending-drupal/contributed-modules/contributed-module-archive/as well?The reason I raised this issue, is because users are finding these Drupal 6/7 doc pages, and they look relevant and updated ...
https://www.drupal.org/forum/support/post-installation/2025-06-07/time-z...
Comment #116
quietone commentedI migration Webform Default Fields to the wrong parent guide. I don't have an option to move it to where is should be, https://www.drupal.org/docs/7/modules/webform-default-fields.
Can someone fix this?
Comment #117
hansfn commentedTried to fix it now.
Comment #118
quietone commented@hansfn, thanks!
I have done all I can on the orphaned pages. I've migrated lots of module and theme pages and deleted some that had replacements or the content was on the project page. I have looked at the remaining pages and nothing stands out that should be kept except for the 'teapot' image. Unfortunately, I don't have a recommendation of where that should go.
Comment #119
quietone commentedOh, I should also mention that I don't know what to do List of Drupal.org former image nodes. What is the plan for all those images?
Comment #120
ressa@drumm I created #3531293: Add "This is archived/old content" banner for old documentation pages.
Comment #121
quietone commentedI asked in committer slack about the teapot image. Gábor Hojtsy said it was from DrupalCon New Orleans, and taken from this image. He looked at the revision log and thought it was an insider joke at one point and he didn't expect it was used for anything. Hope that helps!
Comment #122
drummThanks everyone!
I pushed through the remaining book pages and we’re officially done.